Package org.openxava.model.meta

Class MetaCollection

java.lang.Object

org.openxava.util.meta.MetaElement

org.openxava.model.meta.MetaMember

org.openxava.model.meta.MetaCollection

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MetaMember>, IPropertyValidator

public class MetaCollection
extends MetaMember
implements IPropertyValidator

Author:

Javier Paniza

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MetaCollection()

Method Summary

Modifier and Type	Method	Description
void	addMetaCalculatorPostRemove(MetaCalculator metaCalculator)
java.lang.String	getCondition()
java.util.Collection	getConditionArgumentsPropertyNames()	These arguments can be used in a condition for extracting the values of the collection from the total of the elements of the type.
java.lang.String	getFinderArguments()	Util to generate EJB code.
java.lang.String	getFinderName()	Util to generate EJB code.
java.lang.String	getHQLCondition()
java.lang.String	getInverseCollection()
java.lang.String	getJPACondition()
int	getMaximum()
MetaCalculator	getMetaCalculator()
java.util.Collection	getMetaCalculatorsPostRemove()
java.util.Collection	getMetaPropertiesFinderArguments(boolean withDots)	Util to generate EJB code.
MetaReference	getMetaReference()
int	getMinimum()
java.lang.String	getOrder()
java.lang.String	getSQLConditionWithoutChangePropertiesByColumns()
java.lang.String	getSQLOrder()
boolean	hasCalculator()
boolean	hasCondition()
boolean	hasInverseCollection()
boolean	hasPostRemoveCalculators()
boolean	isAggregate()
boolean	isElementCollection()
boolean	isOrphanRemoval()
boolean	isSortable()
boolean	orderHasQualifiedProperties()
java.lang.String	removeTotalPropertyPrefix(java.lang.String totalProperty)
void	setCondition(java.lang.String string)
void	setElementCollection(boolean elementCollection)
void	setInverseCollection(java.lang.String inverseCollection)
void	setMaximum(int maximum)
void	setMetaCalculator(MetaCalculator metaCalculator)
void	setMetaModel(MetaModel newContainer)
void	setMetaReference(MetaReference reference)
void	setMinimum(int minimum)
void	setOrder(java.lang.String string)
void	setOrphanRemoval(boolean orphanRemoval)
void	setSortable(boolean ordenable)
void	validate(Messages errors, java.lang.Object object, java.lang.String objectName, java.lang.String propertyName)	Validate.

Methods inherited from class org.openxava.model.meta.MetaMember

compareTo, getAnnotations, getId, getLabel, getLabelId, getMetaCalculatorDefaultValue, getMetaModel, getPropertyNamesThatIDepend, getQualifiedName, getSimpleName, hasDefaultValueCalculator, isHidden, isTransient, setLabel, setLabelId, setQualifiedName, setTransient, toQualifiedNames

Methods inherited from class org.openxava.util.meta.MetaElement

getDescription, getDescription, getDescription, getDescription, getLabel, getLabel, getLabel, getLocale, getName, getPlaceholder, getPlaceholder, getPlaceholder, has18nLabel, hasName, setDescription, setName, setPlaceholder

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaCollection

public MetaCollection()

Method Detail

addMetaCalculatorPostRemove

public void addMetaCalculatorPostRemove(MetaCalculator metaCalculator)

getMetaCalculatorsPostRemove

public java.util.Collection getMetaCalculatorsPostRemove()

hasPostRemoveCalculators

public boolean hasPostRemoveCalculators()

getMinimum

public int getMinimum()

setMinimum

public void setMinimum(int minimum)

getMetaReference

public MetaReference getMetaReference()

setMetaReference

public void setMetaReference(MetaReference reference)

isAggregate

public boolean isAggregate()
                    throws XavaException

Throws:

XavaException

setMetaModel

public void setMetaModel(MetaModel newContainer)

Overrides:

setMetaModel in class MetaMember

validate

public void validate(Messages errors,
                     java.lang.Object object,
                     java.lang.String objectName,
                     java.lang.String propertyName)
              throws java.rmi.RemoteException

Description copied from interface: IPropertyValidator

Validate.

The validation errors are added to an object of type Messages.

Specified by:

validate in interface IPropertyValidator

Parameters:

errors - Object that accumulate the list of validation errors.

object - Collection to validate. Has to be of type Collection. If null empty collection is assumed.

objectName - Object that contains the collection to validate.

propertyName - Name of the collection property within objectName.

Throws:

java.rmi.RemoteException

removeTotalPropertyPrefix

public java.lang.String removeTotalPropertyPrefix(java.lang.String totalProperty)

Since:

4.3

getOrder

public java.lang.String getOrder()

setOrder

public void setOrder(java.lang.String string)

getCondition

public java.lang.String getCondition()

setCondition

public void setCondition(java.lang.String string)

getSQLConditionWithoutChangePropertiesByColumns

public java.lang.String getSQLConditionWithoutChangePropertiesByColumns()
                                                                 throws XavaException

Throws:

XavaException

getHQLCondition

public java.lang.String getHQLCondition()
                                 throws XavaException

Throws:

XavaException

getJPACondition

public java.lang.String getJPACondition()
                                 throws XavaException

Throws:

XavaException

orderHasQualifiedProperties

public boolean orderHasQualifiedProperties()

getSQLOrder

public java.lang.String getSQLOrder()
                             throws XavaException

Throws:

XavaException

hasCondition

public boolean hasCondition()

getFinderName

public java.lang.String getFinderName()

Util to generate EJB code.

getFinderArguments

public java.lang.String getFinderArguments()
                                    throws XavaException

Util to generate EJB code.

Throws:

XavaException

getConditionArgumentsPropertyNames

public java.util.Collection getConditionArgumentsPropertyNames()
                                                        throws XavaException

These arguments can be used in a condition for extracting the values of the collection from the total of the elements of the type.

That is, if is a collection of line details of an invoice, this method will return the key of the invoice inside the line detail.
Useful for creating a SQL condition for extracting the value of the collection.

Returns:

Of type String. Never null.

Throws:

XavaException

getMetaPropertiesFinderArguments

public java.util.Collection getMetaPropertiesFinderArguments(boolean withDots)
                                                      throws XavaException

Util to generate EJB code.

Throws:

XavaException

getMetaCalculator

public MetaCalculator getMetaCalculator()

Overrides:

getMetaCalculator in class MetaMember

setMetaCalculator

public void setMetaCalculator(MetaCalculator metaCalculator)

hasCalculator

public boolean hasCalculator()

Overrides:

hasCalculator in class MetaMember

getMaximum

public int getMaximum()

setMaximum

public void setMaximum(int maximum)

setOrphanRemoval

public void setOrphanRemoval(boolean orphanRemoval)

isOrphanRemoval

public boolean isOrphanRemoval()

getInverseCollection

public java.lang.String getInverseCollection()

setInverseCollection

public void setInverseCollection(java.lang.String inverseCollection)

hasInverseCollection

public boolean hasInverseCollection()

isElementCollection

public boolean isElementCollection()

setElementCollection

public void setElementCollection(boolean elementCollection)

isSortable

public boolean isSortable()

setSortable

public void setSortable(boolean ordenable)