Package org.gvsig.fmap.mapcontext.rendering.symbols.impl

Class DefaultSymbolManager

java.lang.Object

org.gvsig.fmap.mapcontext.rendering.symbols.impl.DefaultSymbolManager

All Implemented Interfaces:

SymbolManager

public class DefaultSymbolManager
extends Object
implements SymbolManager

Default SymbolManager implementation.

Author:

gvSIG team

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DefaultSymbolManager.SymbolsLoaderTask

Field Summary

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.SymbolManager

LABELINGSTRATEGY_FILE_EXTENSION, LEGEND_FILE_EXTENSION

Constructor Summary

Constructors

Constructor	Description
DefaultSymbolManager()

Method Summary

Modifier and Type	Method	Description
IMultiLayerSymbol	createMultiLayerSymbol(int shapeType)	Creates a new IMultiLayerSymbol which can be used to render the given Geometry type.
IMultiLayerSymbol	createMultiLayerSymbol(String symbolName)	Creates a new IMultiLayerSymbol.
ISymbol	createSymbol(int shapeType)	Creates a new ISymbol which can be used to render the given Geometry type.
ISymbol	createSymbol(int shapeType, Color color)	Creates a new ISymbol which can be used to render the given Geometry type, with the given Color.
ISymbol	createSymbol(String symbolName)	Creates a new ISymbol.
ISymbol	createSymbol(String symbolName, Color color)	Creates a new ISymbol with the given Color.
static Color	darker(Color col)
ISymbol	getSymbol(String libraryName, String symbolID)
List	getSymbolLibraryNames()
SymbolPreferences	getSymbolPreferences()	Returns the current SymbolPreferences.
IWarningSymbol	getWarningSymbol(String message, String symbolDesc, int symbolDrawExceptionType)	Returns an instance of IWarningSymbol.
static Color	invert(Color col)
static Color	lighter(Color col)
ISymbol	loadSymbol(File file)	Loads a persisted symbol from the given file.
ISymbol[]	loadSymbols(File folder)	Loads the symbols persisted into a folder.
ISymbol[]	loadSymbols(File folder, FileFilter fileFilter)	Loads the symbols persisted into a folder.
org.gvsig.tools.task.CancellableTask	loadSymbols(File folder, FileFilter filter, org.gvsig.tools.visitor.Visitor visitor)
void	registerMultiLayerSymbol(String symbolName, int[] shapeTypes, Class symbolClass)	Registers a IMultiLayerSymbol implementation class with a name and a list of geometry types which the symbol is able to render.
void	registerMultiLayerSymbol(String symbolName, Class symbolClass)	Registers a IMultiLayerSymbol implementation class with a name.
void	registerSymbol(String symbolName, int[] shapeTypes, Class symbolClass)	Registers a ISymbol implementation class with a name and a list of geometry types which the symbol is able to render.
void	registerSymbol(String symbolName, Class symbolClass)	Registers a ISymbol implementation class with a name.
void	saveSymbol(ISymbol symbol, String fileName, File folder)	Persists a ISymbol into the given folder, with the given file name.
void	saveSymbol(ISymbol symbol, String fileName, File folder, boolean overwrite)	Persists a ISymbol into the given folder, with the given file name.
void	setSymbolPreferences(SymbolPreferences symbolPreferences)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultSymbolManager

public DefaultSymbolManager()

Method Details

loadSymbols

public ISymbol[] loadSymbols(File folder)
                      throws SymbolException

Description copied from interface: SymbolManager

Loads the symbols persisted into a folder. It loads the symbols through the use of the current PersistenceManager, loading all files found into the folder.

Specified by:

loadSymbols in interface SymbolManager

Parameters:

folder - to load the persisted symbols from

Returns:

the list of loaded symbols

Throws:

SymbolException - if there is an error loading the symbols

loadSymbols

public ISymbol[] loadSymbols(File folder,
 FileFilter fileFilter)
                      throws SymbolException

Description copied from interface: SymbolManager

Loads the symbols persisted into a folder. It loads the symbols through the use of the current PersistenceManager, loading the files found into the folder which apply to the provided filter.

Specified by:

loadSymbols in interface SymbolManager

Parameters:

folder - to load the persisted symbols from

fileFilter - to apply to know which files to load

Returns:

the list of loaded symbols

Throws:

SymbolException - if there is an error loading the symbols

loadSymbols

public org.gvsig.tools.task.CancellableTask loadSymbols(File folder,
 FileFilter filter,
 org.gvsig.tools.visitor.Visitor visitor)

Specified by:

loadSymbols in interface SymbolManager

saveSymbol

public void saveSymbol(ISymbol symbol,
 String fileName,
 File folder)
                throws SymbolException

Description copied from interface: SymbolManager

Persists a ISymbol into the given folder, with the given file name.

Specified by:

saveSymbol in interface SymbolManager

Parameters:

symbol - to persist

fileName - of the file to create

folder - where to create the file

Throws:

SymbolException - if there is an error persisting the symbol, or the file to create already exists

saveSymbol

public void saveSymbol(ISymbol symbol,
 String fileName,
 File folder,
 boolean overwrite)
                throws SymbolException

Description copied from interface: SymbolManager

Persists a ISymbol into the given folder, with the given file name.

Specified by:

saveSymbol in interface SymbolManager

Parameters:

symbol - to persist

fileName - of the file to create

folder - where to create the file

overwrite - what to do if the file to create already exists

Throws:

SymbolException - if there is an error persisting the symbol, or the file to create already exists and overwrite is false

loadSymbol

public ISymbol loadSymbol(File file)
                   throws SymbolException

Loads a persisted symbol from the given file.

Specified by:

loadSymbol in interface SymbolManager

Throws:

SymbolException

getSymbolPreferences

public SymbolPreferences getSymbolPreferences()

Description copied from interface: SymbolManager

Returns the current SymbolPreferences.

Specified by:

getSymbolPreferences in interface SymbolManager

Returns:

the current SymbolPreferences

createSymbol

public ISymbol createSymbol(String symbolName)
                     throws MapContextRuntimeException

Description copied from interface: SymbolManager

Creates a new ISymbol.

Specified by:

createSymbol in interface SymbolManager

Parameters:

symbolName - the name of the symbol to create

Returns:

a new ISymbol

Throws:

MapContextRuntimeException - if there is an error creating the symbol

createSymbol

public ISymbol createSymbol(int shapeType)
                     throws MapContextRuntimeException

Description copied from interface: SymbolManager

Creates a new ISymbol which can be used to render the given Geometry type.

Specified by:

createSymbol in interface SymbolManager

Parameters:

shapeType - the Geometry type to render

Returns:

a new ISymbol

Throws:

MapContextRuntimeException - if there is an error creating the symbol

createSymbol

public ISymbol createSymbol(String symbolName,
 Color color)
                     throws MapContextRuntimeException

Description copied from interface: SymbolManager

Creates a new ISymbol with the given Color.

Specified by:

createSymbol in interface SymbolManager

Parameters:

symbolName - the name of the symbol to create

color - the color for the symbol

Returns:

a new ISymbol

Throws:

MapContextRuntimeException - if there is an error creating the symbol

createSymbol

public ISymbol createSymbol(int shapeType,
 Color color)
                     throws MapContextRuntimeException

Description copied from interface: SymbolManager

Creates a new ISymbol which can be used to render the given Geometry type, with the given Color.

Specified by:

createSymbol in interface SymbolManager

Parameters:

shapeType - the Geometry type to render

color - the color for the symbol

Returns:

a new ISymbol

Throws:

MapContextRuntimeException - if there is an error creating the symbol

createMultiLayerSymbol

public IMultiLayerSymbol createMultiLayerSymbol(String symbolName)
                                         throws MapContextRuntimeException

Description copied from interface: SymbolManager

Creates a new IMultiLayerSymbol.

Specified by:

createMultiLayerSymbol in interface SymbolManager

Parameters:

symbolName - the name of the symbol to create

Returns:

a new IMultiLayerSymbol

Throws:

MapContextRuntimeException - if there is an error creating the symbol

createMultiLayerSymbol

public IMultiLayerSymbol createMultiLayerSymbol(int shapeType)
                                         throws MapContextRuntimeException

Description copied from interface: SymbolManager

Creates a new IMultiLayerSymbol which can be used to render the given Geometry type.

Specified by:

createMultiLayerSymbol in interface SymbolManager

Parameters:

shapeType - the Geometry type to render

Returns:

a new IMultiLayerSymbol

Throws:

MapContextRuntimeException - if there is an error creating the symbol

registerSymbol

public void registerSymbol(String symbolName,
 Class symbolClass)
                    throws MapContextRuntimeException

Description copied from interface: SymbolManager

Registers a ISymbol implementation class with a name. This way the symbol class is not related to any geometry type, so it can be created only through the SymbolManager.createSymbol(String) method.

Specified by:

registerSymbol in interface SymbolManager

Parameters:

symbolName - the symbol name

symbolClass - the symbol implementation class

Throws:

MapContextRuntimeException - if the provided class does not implement the ISymbol interface

registerSymbol

public void registerSymbol(String symbolName,
 int[] shapeTypes,
 Class symbolClass)
                    throws MapContextRuntimeException

Description copied from interface: SymbolManager

Registers a ISymbol implementation class with a name and a list of geometry types which the symbol is able to render.

Specified by:

registerSymbol in interface SymbolManager

Parameters:

symbolName - the symbol name

shapeTypes - the list of geometry types the symbol is able to render

symbolClass - the symbol implementation class

Throws:

MapContextRuntimeException - if the provided class does not implement the ISymbol interface

registerMultiLayerSymbol

public void registerMultiLayerSymbol(String symbolName,
 Class symbolClass)
                              throws MapContextRuntimeException

Description copied from interface: SymbolManager

Registers a IMultiLayerSymbol implementation class with a name. This way the symbol class is not related to any geometry type, so it can be created only through the SymbolManager.createMultiLayerSymbol(String) method.

Specified by:

registerMultiLayerSymbol in interface SymbolManager

Parameters:

symbolName - the symbol name

symbolClass - the symbol implementation class

Throws:

MapContextRuntimeException - if the provided class does not implement the IMultiLayerSymbol interface

registerMultiLayerSymbol

public void registerMultiLayerSymbol(String symbolName,
 int[] shapeTypes,
 Class symbolClass)
                              throws MapContextRuntimeException

Description copied from interface: SymbolManager

Registers a IMultiLayerSymbol implementation class with a name and a list of geometry types which the symbol is able to render.

Specified by:

registerMultiLayerSymbol in interface SymbolManager

Parameters:

symbolName - the symbol name

shapeTypes - the list of geometry types the symbol is able to render

symbolClass - the symbol implementation class

Throws:

MapContextRuntimeException - if the provided class does not implement the IMultiLayerSymbol interface

getWarningSymbol

public IWarningSymbol getWarningSymbol(String message,
 String symbolDesc,
 int symbolDrawExceptionType)
                                throws MapContextRuntimeException

Description copied from interface: SymbolManager

Returns an instance of IWarningSymbol. TODO: revisar el uso de esto, a ver si es necesario o se puede ocultar dentro de la implementación.

Specified by:

getWarningSymbol in interface SymbolManager

Parameters:

message -

symbolDesc -

symbolDrawExceptionType -

Returns:

the warning symbol

Throws:

MapContextRuntimeException

setSymbolPreferences

public void setSymbolPreferences(SymbolPreferences symbolPreferences)

Specified by:

setSymbolPreferences in interface SymbolManager

getSymbolLibraryNames

public List getSymbolLibraryNames()

Specified by:

getSymbolLibraryNames in interface SymbolManager

getSymbol

public ISymbol getSymbol(String libraryName,
 String symbolID)
                  throws SymbolException

Specified by:

getSymbol in interface SymbolManager

Throws:

SymbolException

darker

public static Color darker(Color col)

Parameters:

col -

Returns:

color 1/3 closer to black

lighter

public static Color lighter(Color col)

Parameters:

col -

Returns:

color 1/3 closer to white

invert

public static Color invert(Color col)

Parameters:

col -

Returns:

inverted color (inverts each band, same alpha)