org.springframework.extensions.surf.types

Class ComponentImpl

java.lang.Object

org.springframework.extensions.surf.types.AbstractModelObject

org.springframework.extensions.surf.render.AbstractRenderableModelObject

org.springframework.extensions.surf.types.ComponentImpl

All Implemented Interfaces:

Serializable, Comparable<Component>, ModelObject, Renderable, ResourceProvider, Component, SurfBugData

Direct Known Subclasses:

AdvancedComponentImpl

public class ComponentImpl
extends AbstractRenderableModelObject
implements Component

Default component implementation

Author:

muzquiano

See Also:

Serialized Form

Field Summary

Fields inherited from class org.springframework.extensions.surf.render.AbstractRenderableModelObject

PROP_PROCESSOR

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

PROP_CHROME, PROP_COMPONENT_TYPE_ID, PROP_GUID, PROP_INDEX, PROP_REGION_ID, PROP_SCOPE, PROP_SOURCE_ID, PROP_URI, PROP_URL, 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
ComponentImpl(String id, ModelPersisterInfo key, org.dom4j.Document document) Instantiates a new component for a given XML document.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Component o)
String	getChrome() Gets the chrome.
ComponentType	getComponentType(RequestContext context) Gets the component type.
String	getComponentTypeId() Gets the component type id.
String	getGUID() Gets the GUID.
String	getIndex() Gets the index of the component.
String	getRegionId() Gets the region id.
org.springframework.extensions.webscripts.WebScript	getResolvedWebScript() Return the WebScript that was resolved to render this component (this will only be available during rendering) it will return null if the component is not backed by a WebScript.
String	getScope() Gets the scope.
String	getSourceId() Gets the source id.
Object	getSourceObject(RequestContext context) Gets the source object.
String	getTypeId() Returns the type id of the model object.
String	getURI() Gets the URI
String	getURL() Gets the URL.
protected void	regenerateId() Regenerate the ID for this component
void	setChrome(String chrome) Sets the chrome.
void	setComponentTypeId(String componentTypeId) Sets the component type id.
void	setGUID(String guid) Sets the GUID.
void	setId(String id) Allows for reassignment of the id of the object
void	setIndex(String index) Sets the index of the component.
void	setRegionId(String regionId) Sets the region id.
void	setResolvedWebScript(org.springframework.extensions.webscripts.WebScript webScript) Store the WebScript resolved for this component (this will only be set if the Component is backed by a WebScript).
void	setScope(String scope) Sets the scope.
void	setSourceId(String sourceId) Sets the source id.
void	setURI(String uri) Sets the URI.
void	setURL(String url) Sets the URL.

Methods inherited from class org.springframework.extensions.surf.render.AbstractRenderableModelObject

getProcessorId, getProcessorId, getProcessorProperties, getProcessorProperties, getProcessorProperty, getProcessorProperty, getRenderModes

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

Constructor Detail

ComponentImpl

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

Instantiates a new component for a given XML document.

Parameters:

document - the 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

getRegionId

public String getRegionId()

Description copied from interface: Component

Gets the region id.

Specified by:

getRegionId in interface Component

Returns:

the region id

setRegionId

public void setRegionId(String regionId)

Description copied from interface: Component

Sets the region id.

Specified by:

setRegionId in interface Component

Parameters:

regionId - the new region id

getSourceId

public String getSourceId()

Description copied from interface: Component

Gets the source id.

Specified by:

getSourceId in interface Component

Returns:

the source id

setSourceId

public void setSourceId(String sourceId)

Description copied from interface: Component

Sets the source id.

Specified by:

setSourceId in interface Component

Parameters:

sourceId - the new source id

getScope

public String getScope()

Description copied from interface: Component

Gets the scope.

Specified by:

getScope in interface Component

Returns:

the scope

setScope

public void setScope(String scope)

Description copied from interface: Component

Sets the scope.

Specified by:

setScope in interface Component

Parameters:

scope - the new scope

getComponentTypeId

public String getComponentTypeId()

Description copied from interface: Component

Gets the component type id.

Specified by:

getComponentTypeId in interface Component

Returns:

the component type id

setComponentTypeId

public void setComponentTypeId(String componentTypeId)

Description copied from interface: Component

Sets the component type id.

Specified by:

setComponentTypeId in interface Component

Parameters:

componentTypeId - the new component type id

getChrome

public String getChrome()

Description copied from interface: Component

Gets the chrome.

Specified by:

getChrome in interface Component

Returns:

the chrome

setChrome

public void setChrome(String chrome)

Description copied from interface: Component

Sets the chrome.

Specified by:

setChrome in interface Component

Parameters:

chrome - the new chrome

getURL

public String getURL()

Description copied from interface: Component

Gets the URL.

Specified by:

getURL in interface Component

Returns:

the URL

setURL

public void setURL(String url)

Description copied from interface: Component

Sets the URL.

Specified by:

setURL in interface Component

Parameters:

url - the new URL

getURI

public String getURI()

Description copied from interface: Component

Gets the URI

Specified by:

getURI in interface Component

Returns:

String

setURI

public void setURI(String uri)

Description copied from interface: Component

Sets the URI.

Specified by:

setURI in interface Component

getGUID

public String getGUID()

Description copied from interface: Component

Gets the GUID.

Specified by:

getGUID in interface Component

Returns:

the GUID

setGUID

public void setGUID(String guid)

Description copied from interface: Component

Sets the GUID.

Specified by:

setGUID in interface Component

Parameters:

guid - the new GUID

getSourceObject

public Object getSourceObject(RequestContext context)

Description copied from interface: Component

Gets the source object.

Specified by:

getSourceObject in interface Component

Parameters:

context - request context

Returns:

the object

getComponentType

public ComponentType getComponentType(RequestContext context)

Description copied from interface: Component

Gets the component type.

Specified by:

getComponentType in interface Component

Parameters:

context - the context

Returns:

the component type

regenerateId

protected void regenerateId()

Regenerate the ID for this component

setId

public void setId(String id)

Description copied from class: AbstractModelObject

Allows for reassignment of the id of the object

Overrides:

setId in class AbstractModelObject

Parameters:

id - String

setResolvedWebScript

public void setResolvedWebScript(org.springframework.extensions.webscripts.WebScript webScript)

Description copied from interface: SurfBugData

Store the WebScript resolved for this component (this will only be set if the Component is backed by a WebScript).

Specified by:

setResolvedWebScript in interface SurfBugData

Parameters:

webScript - WebScript

getResolvedWebScript

public org.springframework.extensions.webscripts.WebScript getResolvedWebScript()

Description copied from interface: SurfBugData

Return the WebScript that was resolved to render this component (this will only be available during rendering) it will return null if the component is not backed by a WebScript.

Specified by:

getResolvedWebScript in interface SurfBugData

Returns:

WebScript

getIndex

public String getIndex()

Description copied from interface: Component

Gets the index of the component. This is only used for ordering components when they are part of a component group and does not have any affect when a component is bound directly to a region.

Specified by:

getIndex in interface Component

Returns:

String

setIndex

public void setIndex(String index)

Description copied from interface: Component

Sets the index of the component. This is only used for ordering components when they are part of a component group and does not have any affect when a component is bound directly to a region.

Specified by:

setIndex in interface Component

compareTo

public int compareTo(Component o)

Specified by:

compareTo in interface Comparable<Component>