org.springframework.extensions.surf.types

Class AbstractModelObject

java.lang.Object

org.springframework.extensions.surf.types.AbstractModelObject

All Implemented Interfaces:

Serializable, ModelObject, ResourceProvider

Direct Known Subclasses:

AbstractRenderableModelObject, ConfigurationImpl, ContentAssociationImpl, ExtensionImpl, ModelObjectCache.ModelObjectSentinel, ModuleDeploymentImpl, PageAssociationImpl, PageImpl, PageTypeImpl, TemplateInstanceImpl, ThemeImpl

public abstract class AbstractModelObject
extends Object
implements ModelObject, ResourceProvider

Abstract base class that can be extended to introduce custom model objects into the framework. Custom model objects must be registered with the configuration file. Once done, they can be loaded and persisted along with other model objects.

All model classes extending from this class are expected to have "id", "title" and "description" fields.

Author:

muzquiano, Kevin Roast

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Serializable>	customProperties
protected String	description
protected String	descriptionId
protected String	id
protected ModelPersisterInfo	info
protected Map<String,Serializable>	modelProperties
protected long	modificationTime
protected ResourceProvider	resourceContainer
protected String	title
protected String	titleId

Fields inherited from interface org.springframework.extensions.surf.ModelObject

PROP_DESCRIPTION, PROP_DESCRIPTION_ID, PROP_ID, PROP_TITLE, PROP_TITLE_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractModelObject() Constructor used by sentinel object
	AbstractModelObject(String id, ModelPersisterInfo info, org.dom4j.Document document) Constructs a new model object

Method Summary

Methods

Modifier and Type	Method and Description
Resource	addResource(String name, String resourceId) Adds/Creates a resource with the given name and resource id
Resource	addResource(String name, String protocolId, String endpointId, String objectId) Adds/Creates a resource with the given name, object id and endpoint id
boolean	getBooleanProperty(String propertyName)
Map<String,Serializable>	getCustomProperties()
String	getCustomProperty(String propertyName)
String	getDescription() Returns the description property of the model object
String	getDescriptionId() Returns the description id property of the model object
org.dom4j.Document	getDocument() Return the representation of this Model Object as an XML DOM.
String	getId() Returns the id of the model object.
ModelPersisterInfo	getKey() Returns the model object key instance
Map<String,Serializable>	getModelProperties()
String	getModelProperty(String propertyName)
long	getModificationTime()
String	getPersisterId() Returns the ModelObjectPersister id that this object is bound to
Map<String,Serializable>	getProperties()
String	getProperty(String propertyName)
Resource	getResource(String name) Looks up a resource with the given name
protected ResourceProvider	getResourceContainer()
Resource[]	getResources() Returns the set of all resources
Map<String,Resource>	getResourcesMap() Returns the map of resources
String	getStoragePath() Returns the persistence storage path of this object
String	getTitle() Returns the title property of the model object.
String	getTitleId() Returns the title id property of the model object.
abstract String	getTypeId() Returns the type id of the model object.
protected boolean	isCustomProperty(String propertyName) Uses reflection to determine whether the given property name is a custom property.
protected boolean	isModelProperty(String propertyName) Uses reflection to determine whether the given property name is a model property.
boolean	isSaved() Indicates whether the object is currently persisted (saved) or not.
void	removeCustomProperty(String propertyName)
void	removeModelProperty(String propertyName)
void	removeProperty(String propertyName)
void	removeResource(String name) Removes a resource with the given name
void	setCustomProperty(String propertyName, String propertyValue)
void	setDescription(String value) Sets the description property of the model object
void	setDescriptionId(String value) Sets the description id property of the model object
void	setId(String id) Allows for reassignment of the id of the object
void	setModelProperty(String propertyName, String propertyValue)
void	setModificationTime(long modificationTime)
void	setProperty(String propertyName, String propertyValue)
void	setTitle(String title) Sets the title property of the model object
void	setTitleId(String titleId) Sets the title id property of the model object
String	toString()
void	touch()
String	toXML() Serializes the object to XML.
void	updateResource(String name, Resource resource) Updates a resource for the given name
protected void	updateXML(org.dom4j.Document document) Method to be used by sub-classes to update the internal serialised representation of the ModelObject from a given XML DOM.

Methods inherited from class java.lang.Object

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

Field Detail

info

protected final ModelPersisterInfo info

id

protected String id

modificationTime

protected long modificationTime

modelProperties

protected Map<String,Serializable> modelProperties

customProperties

protected Map<String,Serializable> customProperties

title

protected String title

titleId

protected String titleId

description

protected String description

descriptionId

protected String descriptionId

resourceContainer

protected ResourceProvider resourceContainer

Constructor Detail

AbstractModelObject

public AbstractModelObject(String id,
                   ModelPersisterInfo info,
                   org.dom4j.Document document)

Constructs a new model object

Parameters:

document - the document

AbstractModelObject

protected AbstractModelObject()

Constructor used by sentinel object

Method Detail

updateXML

protected void updateXML(org.dom4j.Document document)

Method to be used by sub-classes to update the internal serialised representation of the ModelObject from a given XML DOM. The ModelObject itself only ever maintains a serialised XML representation to reduce memory usage as many 10000's of ModelObject instances are stored in the various persister caches.

Parameters:

document - Document for XML serialisation

getKey

public final ModelPersisterInfo getKey()

Description copied from interface: ModelObject

Returns the model object key instance

Specified by:

getKey in interface ModelObject

Returns:

the structure that represents the persistence information for this model object

getId

public final String getId()

Description copied from interface: ModelObject

Returns the id of the model object.

Specified by:

getId in interface ModelObject

Returns:

The id

getTitle

public final String getTitle()

Description copied from interface: ModelObject

Returns the title property of the model object.

Specified by:

getTitle in interface ModelObject

Returns:

The title

getTitleId

public final String getTitleId()

Description copied from interface: ModelObject

Returns the title id property of the model object.

Specified by:

getTitleId in interface ModelObject

Returns:

The title id

setTitle

public final void setTitle(String title)

Description copied from interface: ModelObject

Sets the title property of the model object

Specified by:

setTitle in interface ModelObject

Parameters:

title - The new title

setTitleId

public final void setTitleId(String titleId)

Description copied from interface: ModelObject

Sets the title id property of the model object

Specified by:

setTitleId in interface ModelObject

Parameters:

titleId - The new title id

getDescription

public final String getDescription()

Description copied from interface: ModelObject

Returns the description property of the model object

Specified by:

getDescription in interface ModelObject

Returns:

The description

getDescriptionId

public final String getDescriptionId()

Description copied from interface: ModelObject

Returns the description id property of the model object

Specified by:

getDescriptionId in interface ModelObject

Returns:

The description id

setDescription

public final void setDescription(String value)

Description copied from interface: ModelObject

Sets the description property of the model object

Specified by:

setDescription in interface ModelObject

Parameters:

value - The description

setDescriptionId

public final void setDescriptionId(String value)

Description copied from interface: ModelObject

Sets the description id property of the model object

Specified by:

setDescriptionId in interface ModelObject

Parameters:

value - The description id

isSaved

public final boolean isSaved()

Description copied from interface: ModelObject

Indicates whether the object is currently persisted (saved) or not. A new object will have this flag set to false prior to a save and true once the save operation has completed.

Specified by:

isSaved in interface ModelObject

Returns:

Whether the object is currently saved

getDocument

public final org.dom4j.Document getDocument()

Return the representation of this Model Object as an XML DOM.

Note that this Document is transient and created new each time this method is called from the internal serialised representation. Therefore changes to the ModelObject must be persisted back through the various setProperty() methods or the serialised XML manually updated by an appropriate sub-class method.

Specified by:

getDocument in interface ModelObject

toXML

public final String toXML()

Description copied from interface: ModelObject

Serializes the object to XML. By default, this uses a pretty XML renderer so that the resulting XML is human readable.

Specified by:

toXML in interface ModelObject

Returns:

The XML string

getBooleanProperty

public final boolean getBooleanProperty(String propertyName)

Specified by:

getBooleanProperty in interface ModelObject

getProperty

public final String getProperty(String propertyName)

Specified by:

getProperty in interface ModelObject

setProperty

public final void setProperty(String propertyName,
               String propertyValue)

Specified by:

setProperty in interface ModelObject

removeProperty

public final void removeProperty(String propertyName)

Specified by:

removeProperty in interface ModelObject

isCustomProperty

protected final boolean isCustomProperty(String propertyName)

Uses reflection to determine whether the given property name is a custom property. A custom property is a non-model-specific property. Custom properties are written under the container element in the XML.

Parameters:

propertyName - the property name

Returns:

true, if checks if is custom property

isModelProperty

protected final boolean isModelProperty(String propertyName)

Uses reflection to determine whether the given property name is a model property. Model properties are written directly under the root element of the XML document.

Parameters:

propertyName - the property name

Returns:

true, if checks if is model property

getModelProperty

public final String getModelProperty(String propertyName)

Specified by:

getModelProperty in interface ModelObject

setModelProperty

public final void setModelProperty(String propertyName,
                    String propertyValue)

Specified by:

setModelProperty in interface ModelObject

removeModelProperty

public final void removeModelProperty(String propertyName)

Specified by:

removeModelProperty in interface ModelObject

getCustomProperty

public final String getCustomProperty(String propertyName)

Specified by:

getCustomProperty in interface ModelObject

setCustomProperty

public final void setCustomProperty(String propertyName,
                     String propertyValue)

Specified by:

setCustomProperty in interface ModelObject

removeCustomProperty

public final void removeCustomProperty(String propertyName)

Specified by:

removeCustomProperty in interface ModelObject

getProperties

public Map<String,Serializable> getProperties()

Specified by:

getProperties in interface ModelObject

getModelProperties

public final Map<String,Serializable> getModelProperties()

Specified by:

getModelProperties in interface ModelObject

getCustomProperties

public Map<String,Serializable> getCustomProperties()

Specified by:

getCustomProperties in interface ModelObject

getModificationTime

public final long getModificationTime()

Specified by:

getModificationTime in interface ModelObject

setModificationTime

public final void setModificationTime(long modificationTime)

touch

public final void touch()

Specified by:

touch in interface ModelObject

getTypeId

public abstract String getTypeId()

Description copied from interface: ModelObject

Returns the type id of the model object.

Specified by:

getTypeId in interface ModelObject

Returns:

The type id

toString

public String toString()

Overrides:

toString in class Object

getPersisterId

public final String getPersisterId()

Returns the ModelObjectPersister id that this object is bound to

Specified by:

getPersisterId in interface ModelObject

getStoragePath

public final String getStoragePath()

Returns the persistence storage path of this object

Specified by:

getStoragePath in interface ModelObject

getResource

public Resource getResource(String name)

Description copied from interface: ResourceProvider

Looks up a resource with the given name

Specified by:

getResource in interface ResourceProvider

Parameters:

name - String

Returns:

Resource

getResources

public Resource[] getResources()

Description copied from interface: ResourceProvider

Returns the set of all resources

Specified by:

getResources in interface ResourceProvider

Returns:

Resource[]

getResourcesMap

public Map<String,Resource> getResourcesMap()

Description copied from interface: ResourceProvider

Returns the map of resources

Specified by:

getResourcesMap in interface ResourceProvider

Returns:

Map

addResource

public Resource addResource(String name,
                   String resourceId)

Description copied from interface: ResourceProvider

Adds/Creates a resource with the given name and resource id

Specified by:

addResource in interface ResourceProvider

Parameters:

name - String

resourceId - String

Returns:

resource

addResource

public Resource addResource(String name,
                   String protocolId,
                   String endpointId,
                   String objectId)

Description copied from interface: ResourceProvider

Adds/Creates a resource with the given name, object id and endpoint id

Specified by:

addResource in interface ResourceProvider

Parameters:

name - String

protocolId - String

endpointId - String

objectId - String

Returns:

resource

updateResource

public void updateResource(String name,
                  Resource resource)

Description copied from interface: ResourceProvider

Updates a resource for the given name

Specified by:

updateResource in interface ResourceProvider

Parameters:

name - String

resource - Resource

removeResource

public void removeResource(String name)

Description copied from interface: ResourceProvider

Removes a resource with the given name

Specified by:

removeResource in interface ResourceProvider

Parameters:

name - String

getResourceContainer

protected ResourceProvider getResourceContainer()

setId

public void setId(String id)

Allows for reassignment of the id of the object

Parameters:

id - String