Class Helper
- java.lang.Object
-
- org.codehaus.modello.plugin.velocity.Helper
-
public class Helper extends java.lang.Object
Helper class to use inside velocity templates.This will be made available using
${Helper}
inside the template. For example, the following line will return the list of ancestors for a given modello class:#set ( $ancestors = $Helper.ancestors( $class ) )
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<ModelClass>
ancestors(ModelClass clazz)
Returns the list of ancestors for the givenModelClass
.java.lang.String
capitalise(java.lang.String str)
Returns the capitalised version of the given string.boolean
isFlatItems(ModelField field)
Checks if the givenModelField
is a flat item.java.lang.String
singular(java.lang.String str)
Returns the singular name for the given string.java.lang.String
uncapitalise(java.lang.String str)
Returns the uncapitalised version of the given string.XmlAssociationMetadata
xmAssociationMetadata(ModelField field)
Returns theXmlAssociationMetadata
for the givenModelField
.XmlClassMetadata
xmlClassMetadata(ModelClass clazz)
Returns theXmlClassMetadata
for the givenModelClass
.XmlFieldMetadata
xmlFieldMetadata(ModelField field)
Returns theXmlFieldMetadata
for the givenModelField
.java.util.List<ModelField>
xmlFields(ModelClass modelClass)
Returns a list of allModelField
for a givenModelClass
.
-
-
-
Field Detail
-
version
private final Version version
-
-
Constructor Detail
-
Helper
public Helper(Version version)
-
-
Method Detail
-
capitalise
public java.lang.String capitalise(java.lang.String str)
Returns the capitalised version of the given string.
-
uncapitalise
public java.lang.String uncapitalise(java.lang.String str)
Returns the uncapitalised version of the given string.
-
singular
public java.lang.String singular(java.lang.String str)
Returns the singular name for the given string.
-
ancestors
public java.util.List<ModelClass> ancestors(ModelClass clazz)
Returns the list of ancestors for the givenModelClass
.
-
xmlClassMetadata
public XmlClassMetadata xmlClassMetadata(ModelClass clazz)
Returns theXmlClassMetadata
for the givenModelClass
.
-
xmlFieldMetadata
public XmlFieldMetadata xmlFieldMetadata(ModelField field)
Returns theXmlFieldMetadata
for the givenModelField
.
-
xmAssociationMetadata
public XmlAssociationMetadata xmAssociationMetadata(ModelField field)
Returns theXmlAssociationMetadata
for the givenModelField
.
-
isFlatItems
public boolean isFlatItems(ModelField field)
Checks if the givenModelField
is a flat item.
-
xmlFields
public java.util.List<ModelField> xmlFields(ModelClass modelClass)
Returns a list of allModelField
for a givenModelClass
. The list will contain all fields defined on the class and on its parents, excluding any field flagged as being xml transient.
-
-