org.apache.myfaces.buildtools.maven2.plugin.builder.model
Class ViewEntityMeta

java.lang.Object
  extended by org.apache.myfaces.buildtools.maven2.plugin.builder.model.ClassMeta
      extended by org.apache.myfaces.buildtools.maven2.plugin.builder.model.ViewEntityMeta
All Implemented Interfaces:
PropertyHolder
Direct Known Subclasses:
BehaviorMeta, ComponentMeta, ConverterMeta, ValidatorMeta

public abstract class ViewEntityMeta
extends ClassMeta
implements PropertyHolder

Base class for metadata about any class whose instances can be used in a JSF view.

This means Components, Converters, Validators.


Constructor Summary
ViewEntityMeta(String xmlElementName)
          Constructor.
 
Method Summary
 void addProperty(PropertyMeta property)
          Adds a property to this component.
static void addXmlRules(org.apache.commons.digester.Digester digester, String prefix)
          Add digester rules to repopulate an instance of this type from an xml file.
 String getDescription()
           
 String getLongDescription()
           
 String getName()
           
 Map getProperties()
           
 PropertyMeta getProperty(String propertyName)
           
 Collection getPropertyList()
           
 boolean hasProperties()
          Returns true if this component has any properties.
protected  void merge(ViewEntityMeta other)
           
 Iterator properties()
          Returns an iterator for all properties
 int propertiesSize()
          Number of properties for this component
 void setDescription(String description)
          Sets the brief description of this property.
 void setLongDescription(String longDescription)
          Sets the long description of this property.
 void setName(String name)
          Sets the name that the user will refer to instances of this component by.
protected  void writeXmlComplex(XmlWriter out)
          Implement callback method to write out the "complex" properties of this class as xml.
protected  void writeXmlSimple(XmlWriter out)
          Implement callback method to write out the "simple" properties of this class as xml.
 
Methods inherited from class org.apache.myfaces.buildtools.maven2.plugin.builder.model.ClassMeta
addInterfaceClassName, getClassName, getInterfaceClassNames, getModelId, getPackageName, getParentClassName, getSourceClassName, getSourceClassParentClassName, merge, setClassName, setInterfaceClassNames, setModelId, setParentClassName, setSourceClassName, setSourceClassParentClassName, writeXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ViewEntityMeta

public ViewEntityMeta(String xmlElementName)
Constructor.

Method Detail

addXmlRules

public static void addXmlRules(org.apache.commons.digester.Digester digester,
                               String prefix)
Add digester rules to repopulate an instance of this type from an xml file.


writeXmlSimple

protected void writeXmlSimple(XmlWriter out)
Implement callback method to write out the "simple" properties of this class as xml.

Overrides:
writeXmlSimple in class ClassMeta

writeXmlComplex

protected void writeXmlComplex(XmlWriter out)
Implement callback method to write out the "complex" properties of this class as xml.

Overrides:
writeXmlComplex in class ClassMeta

merge

protected void merge(ViewEntityMeta other)

setName

public void setName(String name)
Sets the name that the user will refer to instances of this component by.

In JSP tags, this value will be used as the JSP tag name.

This property is optional; if not set then this Model instance represents a base class that components can be derived from, but which cannot itself be instantiated as a component.


getName

public String getName()

setDescription

public void setDescription(String description)
Sets the brief description of this property.

This description is used in tooltips, etc.


getDescription

public String getDescription()

setLongDescription

public void setLongDescription(String longDescription)
Sets the long description of this property.


getLongDescription

public String getLongDescription()

addProperty

public void addProperty(PropertyMeta property)
Adds a property to this component.

Specified by:
addProperty in interface PropertyHolder

getProperty

public PropertyMeta getProperty(String propertyName)
Specified by:
getProperty in interface PropertyHolder

propertiesSize

public int propertiesSize()
Number of properties for this component


hasProperties

public boolean hasProperties()
Returns true if this component has any properties.


getProperties

public Map getProperties()
Specified by:
getProperties in interface PropertyHolder

getPropertyList

public Collection getPropertyList()

properties

public Iterator properties()
Returns an iterator for all properties

Specified by:
properties in interface PropertyHolder


Copyright © 2001-2011 The Apache Software Foundation. All Rights Reserved.