org.andromda.cartridges.spring.metafacades

Interface SpringCriteriaAttribute

All Superinterfaces:

AttributeFacade, ModelElementFacade

All Known Implementing Classes:

SpringCriteriaAttributeLogic, SpringCriteriaAttributeLogicImpl

public interface SpringCriteriaAttribute
extends AttributeFacade

Represents a criteria search attribute. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttributeName() Returns the name of the attribute to be used in the criteria query.
String	getComparator() Returns the comparator for the attribute.
String	getComparatorConstant() The comparator as a constant expression usable in the template.
String	getMatchMode() Returns the hibernate matchmode constant to use for matching Strings.
String	getMatchModeConstant() Returns the matchmode constant for usage in templates.
String	getOrderDirection() Returns the order direction if it has been set.
int	getOrderRelevance() Returns the relevance of the ordering setting.
boolean	isComparatorPresent() Indicates whether or not the attribute has a tagged value for the comparator.
boolean	isMatchModePresent() Returns true if a matchmode has ben set.
boolean	isNullable() Defines whether the underlying attribute on the queried entity may be NULL and should therefore be included in the search.
boolean	isOrderable() Returns true if the attribute is used to order the result set.
boolean	isSpringCriteriaAttributeMetaType() Indicates the metafacade type (used for metafacade mappings).

Methods inherited from interface org.andromda.metafacades.uml.AttributeFacade

findTaggedValue, getDefaultValue, getEnumeration, getEnumerationLiteralParameters, getEnumerationValue, getGetterName, getGetterSetterTypeName, getLower, getOwner, getSetterName, getType, getUpper, isAddOnly, isAttributeFacadeMetaType, isChangeable, isDefaultValuePresent, isDerived, isEnumerationLiteral, isEnumerationLiteralParametersExist, isEnumerationMember, isLeaf, isMany, isOrdered, isReadOnly, isRequired, isStatic, isUnique

Methods inherited from interface org.andromda.metafacades.uml.ModelElementFacade

copyTaggedValues, findTaggedValue, findTaggedValues, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getKeywords, getLabel, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getQualifiedName, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getValidationName, getValidationOwner, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, initialize, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, translateConstraint, translateConstraints, translateConstraints, validateInvariants

Method Detail

isSpringCriteriaAttributeMetaType

boolean isSpringCriteriaAttributeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getAttributeName

String getAttributeName()

Returns the name of the attribute to be used in the criteria query.

Returns:

String

getComparator

String getComparator()

Returns the comparator for the attribute.

Returns:

String

getComparatorConstant

String getComparatorConstant()

The comparator as a constant expression usable in the template.

Returns:

String

getMatchMode

String getMatchMode()

Returns the hibernate matchmode constant to use for matching Strings.

Returns:

String

getMatchModeConstant

String getMatchModeConstant()

Returns the matchmode constant for usage in templates.

Returns:

String

getOrderDirection

String getOrderDirection()

Returns the order direction if it has been set.

Returns:

String

getOrderRelevance

int getOrderRelevance()

Returns the relevance of the ordering setting. The lower the number, the more relevant it is.

Returns:

int

isComparatorPresent

boolean isComparatorPresent()

Indicates whether or not the attribute has a tagged value for the comparator.

Returns:

boolean

isMatchModePresent

boolean isMatchModePresent()

Returns true if a matchmode has ben set.

Returns:

boolean

isNullable

boolean isNullable()

Defines whether the underlying attribute on the queried entity may be NULL and should therefore be included in the search.

Returns:

boolean

isOrderable

boolean isOrderable()

Returns true if the attribute is used to order the result set.

Returns:

boolean