org.springframework.extensions.surf.types

Class ExtensionImpl

java.lang.Object

org.springframework.extensions.surf.types.AbstractModelObject

org.springframework.extensions.surf.types.ExtensionImpl

All Implemented Interfaces:

Serializable, ModelObject, ResourceProvider, Extension

public class ExtensionImpl
extends AbstractModelObject
implements Extension

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ExtensionImpl.ModuleObjectAndNode A basic Class that allows the ExtensionModule and Node representations of the same module to be returned together from a method call.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODULE
static String	MODULE_ID_XPATH_QUERY_CLOSE
static String	MODULE_ID_XPATH_QUERY_OPEN

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.Extension

PROP_EXTENSION_TYPE, PROP_MODULES, 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
ExtensionImpl(String id, ModelPersisterInfo key, org.dom4j.Document document) Extends the default constructor by extracting the child elements of the <modules> element and adds the value of any element with the name <module> to the modules java.util.List instance variable.

Method Summary

Methods

Modifier and Type	Method and Description
ExtensionModule	addExtensionModule(String xmlFragment) Adds a new ExtensionModule based on the supplied XML fragment string.
ExtensionModule	deleteExtensionModule(String moduleId) Deleting an ExtensionModule is a two stage process.
List<ExtensionModule>	getExtensionModules()
String	getExtensionType()
String	getTypeId() Returns the type id of the model object.
void	setExtensionType(String extensionType)
ExtensionModule	updateExtensionModule(String xmlFragment) Updates an existing ExtensionModule based on the supplied XML fragment string.

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, equals, 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

Field Detail

MODULE

public static final String MODULE

See Also:

Constant Field Values

MODULE_ID_XPATH_QUERY_OPEN

public static final String MODULE_ID_XPATH_QUERY_OPEN

See Also:

Constant Field Values

MODULE_ID_XPATH_QUERY_CLOSE

public static final String MODULE_ID_XPATH_QUERY_CLOSE

See Also:

Constant Field Values

Constructor Detail

ExtensionImpl

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

Extends the default constructor by extracting the child elements of the <modules> element and adds the value of any element with the name <module> to the modules java.util.List instance variable.

The configuration for the extension point arguments should be similar to:

 <modules>
     <module>mod1</module>
     <module>mod2</module>
     <module>mod3</module>
 </modules>
 

Parameters:

id - String

key - ModelPersisterInfo

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

getExtensionModules

public List<ExtensionModule> getExtensionModules()

Specified by:

getExtensionModules in interface Extension

getExtensionType

public String getExtensionType()

Specified by:

getExtensionType in interface Extension

setExtensionType

public void setExtensionType(String extensionType)

Specified by:

setExtensionType in interface Extension

addExtensionModule

public ExtensionModule addExtensionModule(String xmlFragment)
                                   throws org.dom4j.DocumentException

Adds a new ExtensionModule based on the supplied XML fragment string. The ExtensionModule will only be created if it is defined with an "id" attribute that is not already present in the Extension.

Specified by:

addExtensionModule in interface Extension

Throws:

org.dom4j.DocumentException

updateExtensionModule

public ExtensionModule updateExtensionModule(String xmlFragment)
                                      throws org.dom4j.DocumentException

Updates an existing ExtensionModule based on the supplied XML fragment string. The ExtensionModule will only be updated if it is defined with an "id" attribute that is already present in the Extension.

Specified by:

updateExtensionModule in interface Extension

Throws:

org.dom4j.DocumentException

deleteExtensionModule

public ExtensionModule deleteExtensionModule(String moduleId)

Deleting an ExtensionModule is a two stage process. First it is necessary to locate the ExtensionModule in the List and then remove it if it is present. Secondly it is necessary to update the Document maintained by the ExtensionImpl.

Specified by:

deleteExtensionModule in interface Extension

Parameters:

moduleId - String

Returns:

ExtensionModule