org.richfaces.cdk.model

Class ComponentLibrary

java.lang.Object

org.richfaces.cdk.model.ComponentLibrary

All Implemented Interfaces:

Serializable, Cacheable, Extensible<ConfigExtension>, Trackable, Visitable

public class ComponentLibrary
extends Object
implements Serializable, Extensible<ConfigExtension>, Trackable, Visitable, Cacheable

That class contains model of all JSF components asscoiated with that project

To keep consistence of library references, only library methods are allowed to components manipulations.

Author:

asmirnov@exadel.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CDK_EXTENSIONS_NAMESPACE
static String	FACES_CONFIG_NAMESPACE
static String	FACES_CONFIG_SCHEMA_LOCATION
static String	TAGLIB_SCHEMA_LOCATION

Constructor Summary

Constructors

Constructor and Description
ComponentLibrary()

Method Summary

Methods

Modifier and Type	Method and Description
<R,D> R	accept(Visitor<R,D> visitor, D data)
void	addRenderer(FacesId renderKitId, RendererModel rendererModel)
void	addRenderer(String renderKitId, RendererModel rendererModel)
RenderKitModel	addRenderKit(FacesId renderKitType)
RenderKitModel	addRenderKit(String renderKitId)
ModelCollection<BehaviorModel>	getBehaviors()
ComponentModel	getComponentByFamily(FacesId family)
ComponentModel	getComponentByFamily(String componentFamily)
ComponentModel	getComponentByRenderer(FacesId family, FacesId rendererType)
ComponentModel	getComponentByType(FacesId componentType)
ModelCollection<ComponentModel>	getComponents()
ModelCollection<ConverterModel>	getConverters()
ModelCollection<EventModel>	getEvents()
ConfigExtension	getExtension()
ModelCollection<FunctionModel>	getFunctions()
ModelCollection<ListenerModel>	getListeners()
Boolean	getMetadataComplete()
String	getPrefix()
RendererModel	getRenderer(String componentFamily, String componentType)
RendererModel	getRendererByType(FacesId rendererType)
RenderKitModel	getRenderKit(FacesId id)
ModelCollection<RenderKitModel>	getRenderKits()
Taglib	getTaglib()
ModelCollection<ValidatorModel>	getValidators()
boolean	hasChanged() This method does not track all changes in library, but only models marked as Cacheable.
boolean	isEmpty() Check that library is empty
boolean	isMetadataComplete()
long	lastModified() Last modification time for model information.
void	markUnchanged() Marks the model unchanged, so further changes will make it changed.
void	merge(ComponentLibrary library)
void	setExtension(ConfigExtension extension)
void	setMetadataComplete(boolean metadataComplete)
void	setPrefix(String prefix)
void	setTaglib(Taglib taglib)
void	stopTrackingChanges() Stops tracking any changes, making the model available for merging without tracking changes.

Methods inherited from class java.lang.Object

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

Field Detail

CDK_EXTENSIONS_NAMESPACE

public static final String CDK_EXTENSIONS_NAMESPACE

See Also:

Constant Field Values

FACES_CONFIG_NAMESPACE

public static final String FACES_CONFIG_NAMESPACE

See Also:

Constant Field Values

FACES_CONFIG_SCHEMA_LOCATION

public static final String FACES_CONFIG_SCHEMA_LOCATION

See Also:

Constant Field Values

TAGLIB_SCHEMA_LOCATION

public static final String TAGLIB_SCHEMA_LOCATION

See Also:

Constant Field Values

Constructor Detail

ComponentLibrary

public ComponentLibrary()

Method Detail

accept

public <R,D> R accept(Visitor<R,D> visitor,
             D data)

Specified by:

accept in interface Visitable

addRenderKit

public RenderKitModel addRenderKit(String renderKitId)

Parameters:

renderKitId -

Returns:

addRenderKit

public RenderKitModel addRenderKit(FacesId renderKitType)

getComponents

public ModelCollection<ComponentModel> getComponents()

Returns:

the components

getComponentByRenderer

public ComponentModel getComponentByRenderer(FacesId family,
                                    FacesId rendererType)

getComponentByType

public ComponentModel getComponentByType(FacesId componentType)

getComponentByFamily

public ComponentModel getComponentByFamily(FacesId family)

getComponentByFamily

public ComponentModel getComponentByFamily(String componentFamily)

getRendererByType

public RendererModel getRendererByType(FacesId rendererType)

getRenderKits

public ModelCollection<RenderKitModel> getRenderKits()

Returns:

the renderKits

getRenderKit

public RenderKitModel getRenderKit(FacesId id)

addRenderer

public void addRenderer(FacesId renderKitId,
               RendererModel rendererModel)

addRenderer

public void addRenderer(String renderKitId,
               RendererModel rendererModel)

getRenderer

public RendererModel getRenderer(String componentFamily,
                        String componentType)

getConverters

public ModelCollection<ConverterModel> getConverters()

Returns:

the converters

getValidators

public ModelCollection<ValidatorModel> getValidators()

Returns:

the validators

getBehaviors

public ModelCollection<BehaviorModel> getBehaviors()

Returns:

the behaviors

getListeners

public ModelCollection<ListenerModel> getListeners()

Returns:

the listeners

getEvents

public ModelCollection<EventModel> getEvents()

Returns:

the events

getFunctions

public ModelCollection<FunctionModel> getFunctions()

Returns:

the functions

getExtension

public ConfigExtension getExtension()

Specified by:

getExtension in interface Extensible<ConfigExtension>

Returns:

the extension

setExtension

public void setExtension(ConfigExtension extension)

Specified by:

setExtension in interface Extensible<ConfigExtension>

Parameters:

extension - the extension to set

isMetadataComplete

public boolean isMetadataComplete()

Returns:

the metadataComplete

setMetadataComplete

public void setMetadataComplete(boolean metadataComplete)

Parameters:

metadataComplete - the metadataComplete to set

getMetadataComplete

public Boolean getMetadataComplete()

getPrefix

public String getPrefix()

setPrefix

public void setPrefix(String prefix)

getTaglib

public Taglib getTaglib()

setTaglib

public void setTaglib(Taglib taglib)

lastModified

public long lastModified()

Description copied from interface: Trackable

Last modification time for model information.

Specified by:

lastModified in interface Trackable

Returns:

isEmpty

public boolean isEmpty()

Check that library is empty

Parameters:

this -

Returns:

merge

public void merge(ComponentLibrary library)

markUnchanged

public void markUnchanged()

Description copied from interface: Cacheable

Marks the model unchanged, so further changes will make it changed. You may do any changes which should not be tracked and then call this method to track further changes.

Specified by:

markUnchanged in interface Cacheable

hasChanged

public boolean hasChanged()

This method does not track all changes in library, but only models marked as Cacheable.

Specified by:

hasChanged in interface Cacheable

stopTrackingChanges

public void stopTrackingChanges()

Description copied from interface: Cacheable

Stops tracking any changes, making the model available for merging without tracking changes.

Specified by:

stopTrackingChanges in interface Cacheable