org.gvsig.tools.persistence

Interface PersistenceFactory

All Known Subinterfaces:

DocumentManager, LayoutManager

All Known Implementing Classes:

AbstractDocumentManager, AbstractMultiPersistenceFactory, AbstractSinglePersistenceFactory, ColorPersistenceFactory, CoordTransPersistenceFactory, DefaultLayoutManager, DimensionPersistenceFactory, DynObjectPersistenceFactory, FeatureReferencePersistenceFactory, FontPersistenceFactory, GeometryPersistenceFactory, GeometryTypePersistenceFactory, JavaTextFactory, MapserverAlignEnumPersistenceFactory, MapserverBigIntegerPersistenceFactory, MapserverBooleanEnumPersistenceFactory, MapserverClassPersistenceFactory, MapserverColorPersistenceFactory, MapserverExpressionTypePersistenceFactory, MapserverLabelPersistenceFactory, MapserverLayerPersistenceFactory, MapserverMapPersistenceFactory, MapserverOutputFormatPersistenceFactory, MapserverPointsPersistenceFactory, MapserverPointTypePersistenceFactory, MapserverSizeTypePersistenceFactory, MapserverStylePersistenceFactory, MapserverSymbolPersistenceFactory, MapserverSymbolSetPersistenceFactory, MapserverSymbolTypePersistenceFactory, MapserverWebPersistenceFactory, Point2DPersistenceFactory, PortableViewDocumentManager, ProjectionPersistenceFactory, RasterStorePersistenceFactory, Rectangle2DPersistenceFactory, SimplePersistenceFactory, TableManager, TinyOWSLayerPersistenceFactory, TinyOWSPersistenceFactory, ViewManager

public interface PersistenceFactory

Interface for factories of objects that no implements Persistent and must be supported by PersistenceManager.

This can be used when the objects to persist can't be created by empty constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	createFromState(PersistentState state) Create an instance of the object represented by the state.
DynStruct	getDefinition(java.lang.String className) Returns the associated definition to the java class name
java.util.List	getDefinitions() Return a List of the definition managed by this factory where the key is className and value is definition
java.lang.String	getDomainName() Returns the domain name of the objects persisted by this factory.
java.lang.String	getDomainURL() Returns the domain URL to use for the schema.
java.lang.Class	getManagedClass(java.lang.Object object) Return the class or interface the factory asociate to the object.
java.lang.Class	getManagedClass(PersistentState state) Return the class or interface the factory asociate to the object.
java.lang.Class	getManagedClass(java.lang.String name) Return the class or interface the factory asociate to the java class name.
java.util.List	getManagedClasses() Return the list of classes or interfaces managed by this factory.
java.lang.String	getManagedClassName(java.lang.Object object) Return the name class or interface the factory asociate to the object.
void	loadFromState(PersistentState state, java.lang.Object object) Load a instance of classToUse from state data.
boolean	manages(java.lang.Class theClass) Informs if theClass is managed by this factory.
boolean	manages(java.lang.Object object) Informs if object is managed by this factory.
boolean	manages(PersistentState state) Informs if this factory can recreate the object represented by state.
void	saveToState(PersistentState state, java.lang.Object obj) Fill state with data to persist of obj.

Method Detail

createFromState

java.lang.Object createFromState(PersistentState state)
                          throws PersistenceException

Create an instance of the object represented by the state. This method can't call loadFromState(PersistentState, Object) only create the object.

Parameters:

state -

Returns:

the object

Throws:

PersistenceException

loadFromState

void loadFromState(PersistentState state,
                   java.lang.Object object)
            throws PersistenceException

Load a instance of classToUse from state data.

Parameters:

state -

object -

Throws:

PersistenceException

saveToState

void saveToState(PersistentState state,
                 java.lang.Object obj)
          throws PersistenceException

Fill state with data to persist of obj.

Parameters:

state -

obj -

Throws:

PersistenceException

manages

boolean manages(java.lang.Object object)

Informs if object is managed by this factory.

Parameters:

object -

Returns:

true if the object is managed by the factory.

manages

boolean manages(java.lang.Class theClass)

Informs if theClass is managed by this factory.

Parameters:

class - to check.

Returns:

true if the class is managed by the factory.

manages

boolean manages(PersistentState state)

Informs if this factory can recreate the object represented by state.

Parameters:

object -

Returns:

getDefinitions

java.util.List getDefinitions()

Return a List of the definition managed by this factory where the key is className and value is definition

Returns:

Map

getDefinition

DynStruct getDefinition(java.lang.String className)

Returns the associated definition to the java class name

Parameters:

className - of a java Class

Returns:

the related definition or null if not managed by this factory

getDomainName

java.lang.String getDomainName()

Returns the domain name of the objects persisted by this factory.

Returns:

the domain name

getDomainURL

java.lang.String getDomainURL()

Returns the domain URL to use for the schema.

Returns:

the domain URL

getManagedClasses

java.util.List getManagedClasses()

Return the list of classes or interfaces managed by this factory. Can return null if factory not use it.

Returns:

List of interfaces the factory manage

getManagedClass

java.lang.Class getManagedClass(java.lang.Object object)

Return the class or interface the factory asociate to the object. Can return null if factory not asociate an interface to the object.

Parameters:

object -

Returns:

interface the factory manage asociated to the object.

getManagedClassName

java.lang.String getManagedClassName(java.lang.Object object)

Return the name class or interface the factory asociate to the object. Can return null if factory not asociate an interface to the object.

Parameters:

object -

Returns:

interface the factory manage asociated to the object.

getManagedClass

java.lang.Class getManagedClass(PersistentState state)

Return the class or interface the factory asociate to the object. Can return null if factory not asociate an interface to the object.

Parameters:

state -

Returns:

interface or class the factory manage asociated to the state.

getManagedClass

java.lang.Class getManagedClass(java.lang.String name)

Return the class or interface the factory asociate to the java class name. Can return null if factory not asociate an interface to that name.

Parameters:

name -

Returns:

interface or class the factory manage asociated to the name.