org.springframework.extensions.surf.types

Class ModuleDeploymentImpl

java.lang.Object

org.springframework.extensions.surf.types.AbstractModelObject

org.springframework.extensions.surf.types.ModuleDeploymentImpl

All Implemented Interfaces:

Serializable, Comparable<ModuleDeployment>, ModelObject, ResourceProvider, ModuleDeployment

public class ModuleDeploymentImpl
extends AbstractModelObject
implements ModuleDeployment

See Also:

Serialized Form

Field Summary

Fields inherited from class org.springframework.extensions.surf.types.AbstractModelObject

customProperties, description, descriptionId, id, info, modelProperties, modificationTime, resourceContainer, title, titleId

Fields inherited from interface org.springframework.extensions.surf.types.ModuleDeployment

PROP_EVALUATOR_OVERRIDE, PROP_EVALUATOR_PROPERTY_OVERRIDES, PROP_EXTENSION_MODULE, PROP_INDEX, PROP_MODULE_DEPLOYMENT_TYPE, TYPE_ID

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

PROP_DESCRIPTION, PROP_DESCRIPTION_ID, PROP_ID, PROP_TITLE, PROP_TITLE_ID

Constructor Summary

Constructors

Constructor and Description
ModuleDeploymentImpl(String id, ModelPersisterInfo key, org.dom4j.Document document)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ModuleDeployment o)
boolean	equals(Object obj) A ModuleDeploymentImpl is considered equal to another object if that object is either another ModuleDeployment with the same ID or an ExtensionModule with the same ID.
AdvancedComponent	getAdvancedComponent(String id) Checks to see if the module declares an extension to the AdvancedComponent defined by the supplied id.
Map<String,AdvancedComponent>	getAdvancedComponents()
String	getAutoDeployIndex()
List<org.springframework.extensions.surf.extensibility.Customization>	getCustomizations()
String	getEvaluator()
String	getEvaluatorOverride()
Map<String,String>	getEvaluatorProperties()
Map<String,String>	getEvaluatorPropertyOverrides()
ExtensionModule	getExtensionModule()
String	getExtensionModuleId()
int	getIndex()
String	getModuleDeploymentType()
String	getTypeId() Returns the type id of the model object.
String	getVersion()
void	setEvaluatorOverride(String evaluatorOverride)
void	setEvaluatorPropertyOverrides(Map<String,String> evaluatorProperties)
void	setExtensionModule(ExtensionModule extensionModule)
void	setExtensionModuleId(String extensionModuleId)
void	setIndex(int index)
void	setModuleDeploymentType(String extensionType)

Methods inherited from class org.springframework.extensions.surf.types.AbstractModelObject

addResource, addResource, getBooleanProperty, getCustomProperties, getCustomProperty, getDescription, getDescriptionId, getDocument, getId, getKey, getModelProperties, getModelProperty, getModificationTime, getPersisterId, getProperties, getProperty, getResource, getResourceContainer, getResources, getResourcesMap, getStoragePath, getTitle, getTitleId, isCustomProperty, isModelProperty, isSaved, removeCustomProperty, removeModelProperty, removeProperty, removeResource, setCustomProperty, setDescription, setDescriptionId, setId, setModelProperty, setModificationTime, setProperty, setTitle, setTitleId, toString, touch, toXML, updateResource, updateXML

Methods inherited from class java.lang.Object

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

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

getBooleanProperty, getCustomProperties, getCustomProperty, getDescription, getDescriptionId, getDocument, getId, getKey, getModelProperties, getModelProperty, getModificationTime, getPersisterId, getProperties, getProperty, getStoragePath, getTitle, getTitleId, isSaved, removeCustomProperty, removeModelProperty, removeProperty, setCustomProperty, setDescription, setDescriptionId, setModelProperty, setProperty, setTitle, setTitleId, touch, toXML

Constructor Detail

ModuleDeploymentImpl

public ModuleDeploymentImpl(String id,
                    ModelPersisterInfo key,
                    org.dom4j.Document document)

Method Detail

getTypeId

public String getTypeId()

Description copied from interface: ModelObject

Returns the type id of the model object.

Specified by:

getTypeId in interface ModelObject

Specified by:

getTypeId in class AbstractModelObject

Returns:

The type id

getModuleDeploymentType

public String getModuleDeploymentType()

Specified by:

getModuleDeploymentType in interface ModuleDeployment

setModuleDeploymentType

public void setModuleDeploymentType(String extensionType)

Specified by:

setModuleDeploymentType in interface ModuleDeployment

getExtensionModuleId

public String getExtensionModuleId()

Specified by:

getExtensionModuleId in interface ModuleDeployment

setExtensionModuleId

public void setExtensionModuleId(String extensionModuleId)

Specified by:

setExtensionModuleId in interface ModuleDeployment

getExtensionModule

public ExtensionModule getExtensionModule()

Specified by:

getExtensionModule in interface ModuleDeployment

setExtensionModule

public void setExtensionModule(ExtensionModule extensionModule)

Specified by:

setExtensionModule in interface ModuleDeployment

getIndex

public int getIndex()

Specified by:

getIndex in interface ModuleDeployment

setIndex

public void setIndex(int index)

Specified by:

setIndex in interface ModuleDeployment

compareTo

public int compareTo(ModuleDeployment o)

Specified by:

compareTo in interface Comparable<ModuleDeployment>

equals

public boolean equals(Object obj)

A ModuleDeploymentImpl is considered equal to another object if that object is either another ModuleDeployment with the same ID or an ExtensionModule with the same ID. This implementation is based on the assumption that all module IDs (whether deployed or not) are unique within the context of the application. The benefit of this is that Collection instances of can use the .contains() method when comparing lists deployed and undeployed objects.

Overrides:

equals in class Object

getVersion

public String getVersion()

Specified by:

getVersion in interface ModuleDeployment

getAutoDeployIndex

public String getAutoDeployIndex()

Specified by:

getAutoDeployIndex in interface ModuleDeployment

getEvaluator

public String getEvaluator()

Specified by:

getEvaluator in interface ModuleDeployment

getEvaluatorProperties

public Map<String,String> getEvaluatorProperties()

Specified by:

getEvaluatorProperties in interface ModuleDeployment

setEvaluatorOverride

public void setEvaluatorOverride(String evaluatorOverride)

Specified by:

setEvaluatorOverride in interface ModuleDeployment

setEvaluatorPropertyOverrides

public void setEvaluatorPropertyOverrides(Map<String,String> evaluatorProperties)

Specified by:

setEvaluatorPropertyOverrides in interface ModuleDeployment

getEvaluatorOverride

public String getEvaluatorOverride()

Specified by:

getEvaluatorOverride in interface ModuleDeployment

getEvaluatorPropertyOverrides

public Map<String,String> getEvaluatorPropertyOverrides()

Specified by:

getEvaluatorPropertyOverrides in interface ModuleDeployment

getAdvancedComponents

public Map<String,AdvancedComponent> getAdvancedComponents()

getAdvancedComponent

public AdvancedComponent getAdvancedComponent(String id)

Description copied from interface: ModuleDeployment

Checks to see if the module declares an extension to the AdvancedComponent defined by the supplied id. If the an extension has been declared then it is returned.

Specified by:

getAdvancedComponent in interface ModuleDeployment

Parameters:

id - The identifier of the AdvancedComponent extension to retrieve.

Returns:

A AdvancedComponent extension matching the supplied id.

getCustomizations

public List<org.springframework.extensions.surf.extensibility.Customization> getCustomizations()

Specified by:

getCustomizations in interface ModuleDeployment