org.springframework.extensions.surf.types

Class AdvancedComponentImpl

java.lang.Object

org.springframework.extensions.surf.types.AbstractModelObject

org.springframework.extensions.surf.render.AbstractRenderableModelObject

org.springframework.extensions.surf.types.ComponentImpl

org.springframework.extensions.surf.types.AdvancedComponentImpl

All Implemented Interfaces:

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

public class AdvancedComponentImpl
extends ComponentImpl
implements AdvancedComponent

Author:

David Draper

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUB_COMPONENT_ELEMENT_CONVERSION_ID When instantiating an AdvancedComponent from configuration intended for Component this is the identifier that will be given to the single SubComponent generated.

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

COMPONENT, EVALUATION, EVALUATIONS, EVALUATOR, EVALUATORS, ID, INDEX, NAME, NEGATE, PARAM, PARAMS, PROPERTIES, RENDER_IF_EVALUATED, SUB_COMPONENT, SUB_COMPONENTS, TYPE, URI, URL, VALUE

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
AdvancedComponentImpl(String id, ModelPersisterInfo key, org.dom4j.Document document)

Method Summary

Methods

Modifier and Type	Method and Description
void	applyConfig(org.dom4j.Element componentEl) Initialises the AdvancedComponentImpl instance by parsing the supplied XML configuration Element.
List<SubComponent>	getSubComponents() Retrieve the sub component list for this component.
boolean	isAdvancedConfig() Indicates whether or not this instance was instantiated from configuration specifically tailored for an AdvancedComponent or for a Component.
void	setSubComponents(List<SubComponent> subComponents) Sets the the List of SubComponent instances that are owned by this AdvancedComponent.

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

compareTo, getChrome, getComponentType, getComponentTypeId, getGUID, getIndex, getRegionId, getResolvedWebScript, getScope, getSourceId, getSourceObject, getTypeId, getURI, getURL, regenerateId, setChrome, setComponentTypeId, setGUID, setId, setIndex, setRegionId, setResolvedWebScript, setScope, setSourceId, setURI, setURL

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

getChrome, getComponentType, getComponentTypeId, getGUID, getIndex, getRegionId, getScope, getSourceId, getSourceObject, getURI, getURL, setChrome, setComponentTypeId, setGUID, setIndex, setRegionId, setScope, setSourceId, setURI, setURL

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, getTypeId, isSaved, removeCustomProperty, removeModelProperty, removeProperty, setCustomProperty, setDescription, setDescriptionId, setModelProperty, setProperty, setTitle, setTitleId, touch, toXML

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.springframework.extensions.surf.types.SurfBugData

getResolvedWebScript, setResolvedWebScript

Field Detail

SUB_COMPONENT_ELEMENT_CONVERSION_ID

public static final String SUB_COMPONENT_ELEMENT_CONVERSION_ID

When instantiating an AdvancedComponent from configuration intended for Component this is the identifier that will be given to the single SubComponent generated.

See Also:

Constant Field Values

Constructor Detail

AdvancedComponentImpl

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

Method Detail

isAdvancedConfig

public boolean isAdvancedConfig()

Indicates whether or not this instance was instantiated from configuration specifically tailored for an AdvancedComponent or for a Component.

Specified by:

isAdvancedConfig in interface AdvancedComponent

getSubComponents

public List<SubComponent> getSubComponents()

Retrieve the sub component list for this component.

Specified by:

getSubComponents in interface AdvancedComponent

Returns:

A List of SubComponent instances directly configured (i.e. not defined in an ExtensionModule).

setSubComponents

public void setSubComponents(List<SubComponent> subComponents)

Sets the the List of SubComponent instances that are owned by this AdvancedComponent.

Specified by:

setSubComponents in interface AdvancedComponent

applyConfig

public void applyConfig(org.dom4j.Element componentEl)

Initialises the AdvancedComponentImpl instance by parsing the supplied XML configuration Element. This will build a list of SubComponent instances. Parsing of the configuration for each SubComponent is deferred to each instance created.

Specified by:

applyConfig in interface AdvancedComponent