com.plumtree.portaluiinfrastructure.tags.helper
Class TagMetaDataHelper

java.lang.Object
  com.plumtree.portaluiinfrastructure.tags.helper.TagMetaDataHelper

public class TagMetaDataHelper
extends java.lang.Object

This helper class uses XPReflect to read in the tag meta data. This class should be called once per tag class and stored as a static on the ATag class.

Author:

DonH

Field Summary

protected OptionalTagAttribute[]	m_OptionalTagAttributes
protected ITagMetaData[]	m_RequiredChildTags
protected ITagMetaData[]	m_RequiredParentTags
protected RequiredTagAttribute[]	m_RequiredTagAttributes
protected TagLibraryMetaData	m_TagLibraryMetaData
protected ITagMetaData	m_TagMetaData

Constructor Summary

TagMetaDataHelper()

Method Summary

OptionalTagAttribute[]	GetOptionalTagAttributes() Gets the meta data for the optional tag attributes for this tag.
ITagMetaData[]	GetRequiredChildTags() Gets the required child tags meta data for this tag.
ITagMetaData[]	GetRequiredParentTags() Gets the required parent tags meta data for this tag.
RequiredTagAttribute[]	GetRequiredTagAttributes() Gets the meta data for the required tag attributes for this tag.
TagLibraryMetaData	GetTagLibraryMetaData() Store the Tag Library meta data object for the Tag Library that contains this Tag.
ITagMetaData	GetTagMetaData() Gets the meta data for this tag.
boolean	Init(ATag _Tag, TagLibraryMetaData _TagLibMetaData) This method uses reflection to discover all of the meta data about this tag and caches it for quick lookup in the future.

Methods inherited from class java.lang.Object

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

Field Detail

m_TagMetaData

protected ITagMetaData m_TagMetaData

m_TagLibraryMetaData

protected TagLibraryMetaData m_TagLibraryMetaData

m_RequiredTagAttributes

protected RequiredTagAttribute[] m_RequiredTagAttributes

m_OptionalTagAttributes

protected OptionalTagAttribute[] m_OptionalTagAttributes

m_RequiredParentTags

protected ITagMetaData[] m_RequiredParentTags

m_RequiredChildTags

protected ITagMetaData[] m_RequiredChildTags

Constructor Detail

TagMetaDataHelper

public TagMetaDataHelper()

Method Detail

Init

public boolean Init(ATag _Tag,
                    TagLibraryMetaData _TagLibMetaData)

This method uses reflection to discover all of the meta data about this tag and caches it for quick lookup in the future. This method is only called once per tag class when the class is loaded. Framework Helper Method

Returns:

boolean false means that the meta data was unable to be initialized properly, and this tag cannot be used.

GetTagLibraryMetaData

public TagLibraryMetaData GetTagLibraryMetaData()

Store the Tag Library meta data object for the Tag Library that contains this Tag.

Returns:

TagLibraryMetaData The meta data object for the Tag Library that contains this Tag.

GetTagMetaData

public ITagMetaData GetTagMetaData()

Gets the meta data for this tag.

Returns:

TagMetaData the meta data for this tag.

GetRequiredTagAttributes

public RequiredTagAttribute[] GetRequiredTagAttributes()

Gets the meta data for the required tag attributes for this tag.

Returns:

RequiredTagAttribute[] The meta data for the required tag attributes for this tag. This array may be empty.

GetOptionalTagAttributes

public OptionalTagAttribute[] GetOptionalTagAttributes()

Gets the meta data for the optional tag attributes for this tag.

Returns:

OptionalTagAttribute[] The meta data for the optional tag attributes for this tag. This array may be empty.

GetRequiredParentTags

public ITagMetaData[] GetRequiredParentTags()

Gets the required parent tags meta data for this tag.

Returns:

ITagMetaData[] The required parent tags meta data for this tag. This array may be empty.

GetRequiredChildTags

public ITagMetaData[] GetRequiredChildTags()

Gets the required child tags meta data for this tag.

Returns:

ITagMetaData[] The meta data for the required child tags for this tag. This array may be empty.