org.andromda.cartridges.jsf2.metafacades

Interface JSFAttribute

All Superinterfaces:

AttributeFacade, ModelElementFacade

All Known Implementing Classes:

JSFAttributeLogic, JSFAttributeLogicImpl

public interface JSFAttribute
extends AttributeFacade

Represents an attribute on a classifier used by a JSF application. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBackingListName(ParameterFacade ownerParameter) Gets backing list name for this attribute.
String	getBackingValueName(ParameterFacade ownerParameter) Constructs and returns the backing value name given the 'ownerParameter'.
String	getDateFormatter(JSFParameter ownerParameter) Gets the name of the date formatter for this attribute by constructing the name from the 'ownerParameter' (if this attribute represents a date).
String	getDummyValue() The dummy value to give the attribute when creating a dummy instance of this attribute's owner.
String	getFormat() If this attributes represents a date or time this method will return the format in which it must be represented.
String	getFormPropertyId(ParameterFacade ownerParameter) Gets the unique id of this attribute on the form.
String	getFormPropertyName(ParameterFacade ownerParameter) Retrieves the name of the form property for this attribute by taking the name of the owner property.
String	getInputTableIdentifierColumns() A comma separated list of the input table identifier columns (these are the columns that uniquely define a row in an input table).
String	getLabelListName(ParameterFacade ownerParameter) Gets the name of the label list for this parameter.
String	getMaxLength() The max length allowed in the input component
String	getMessageKey() The message key for this attribute.
String	getMessageValue() The default value for the message key.
String	getTimeFormatter(JSFParameter ownerParameter) Gets the name of the time formatter (if this parameter represents a time).
Collection	getValidatorArgs(String validatorType) Gets the arguments for this parameter's validators.
Collection	getValidatorTypes() All validator types for this attribute.
Collection	getValidatorVars(JSFParameter ownerParameter) Gets the validator args for this attribute
String	getValidWhen() The validator's 'validwhen' value, this is useful when the validation of a parameter depends on the validation of others.
String	getValueListDummyValue() The dummy value for a value list.
String	getValueListName(ParameterFacade ownerParameter) Gets the name of the value list for this parameter; this list stores the possible values that this attribute may be (typically used for the values of a drop-down select list).
boolean	isBackingValueRequired(FrontEndParameter ownerParameter) Indicates whether or not the backing value is required for this attribute (depending on the 'ownerParameter').
boolean	isEqualValidator() Indicates whether or not this parameter uses the equal validator.
boolean	isInputCheckbox() Indicates if this parameter represents a checkbox widget.
boolean	isInputFile() Indicates whether or not this is a file input type.
boolean	isInputHidden() Indicates whether or not this parameter represents a hidden input widget.
boolean	isInputMultibox() Indicates whether or not this type represents an input multibox.
boolean	isInputRadio() Indicates whether or not this parameter should be rendered as an input radio widget.
boolean	isInputSecret() Indicates whether or not this parameter represents an input "secret" widget (i.e.
boolean	isInputSelect() Indicates whether or not this parameter represents an input select widget.
boolean	isInputTable() Indicates whether or not this is an table input type.
boolean	isInputText() Indicates whether or not this parameter should be rendered as a text input widget.
boolean	isInputTextarea() Indicates if this parameter represents as an input text area widget.
boolean	isInputTypePresent() Indicates whether or not there is an input type defined for this attribute.
boolean	isJSFAttributeMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isPlaintext() Indicates whether or not this attribute's value should be rendered as plain text (not as a widget).
boolean	isSelectable(FrontEndParameter ownerParameter) Indicates whether or not this attribute is selectable according to its 'ownerParameter'.
boolean	isStrictDateFormat() Indicates where or not the date format is to be strictly respected.
boolean	isValidationRequired() Indicates whether or not this attribute requires some kind of validation (the collection of validator types is not empty).

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

isJSFAttributeMetaType

boolean isJSFAttributeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getBackingListName

String getBackingListName(ParameterFacade ownerParameter)

Gets backing list name for this attribute. This is useful if you want to be able to select the attribute value from a list (i.e. a drop-down select input type).

Parameters:

ownerParameter - ParameterFacade

Returns:

String

getBackingValueName

String getBackingValueName(ParameterFacade ownerParameter)

Constructs and returns the backing value name given the 'ownerParameter'.

Parameters:

ownerParameter - ParameterFacade

Returns:

String

getDateFormatter

String getDateFormatter(JSFParameter ownerParameter)

Gets the name of the date formatter for this attribute by constructing the name from the 'ownerParameter' (if this attribute represents a date).

Parameters:

ownerParameter - JSFParameter

Returns:

String

getDummyValue

String getDummyValue()

The dummy value to give the attribute when creating a dummy instance of this attribute's owner.

Returns:

String

getFormPropertyId

String getFormPropertyId(ParameterFacade ownerParameter)

Gets the unique id of this attribute on the form.

Parameters:

ownerParameter - ParameterFacade

Returns:

String

getFormPropertyName

String getFormPropertyName(ParameterFacade ownerParameter)

Retrieves the name of the form property for this attribute by taking the name of the owner property.

Parameters:

ownerParameter - ParameterFacade

Returns:

String

getFormat

String getFormat()

If this attributes represents a date or time this method will return the format in which it must be represented. In the event this format has not been specified by the any tagged value the default will be used.

Returns:

String

getInputTableIdentifierColumns

String getInputTableIdentifierColumns()

A comma separated list of the input table identifier columns (these are the columns that uniquely define a row in an input table).

Returns:

String

getLabelListName

String getLabelListName(ParameterFacade ownerParameter)

Gets the name of the label list for this parameter. The label list name is the name of the list storing the labels for the possible values of this attribute (typically used for the labels of a drop-down select lists).

Parameters:

ownerParameter - ParameterFacade

Returns:

String

getMaxLength

String getMaxLength()

The max length allowed in the input component

Returns:

String

getMessageKey

String getMessageKey()

The message key for this attribute.

Returns:

String

getMessageValue

String getMessageValue()

The default value for the message key.

Returns:

String

getTimeFormatter

String getTimeFormatter(JSFParameter ownerParameter)

Gets the name of the time formatter (if this parameter represents a time).

Parameters:

ownerParameter - JSFParameter

Returns:

String

getValidWhen

String getValidWhen()

The validator's 'validwhen' value, this is useful when the validation of a parameter depends on the validation of others. See the apache commons-validator documentation for more information.

Returns:

String

getValidatorArgs

Collection getValidatorArgs(String validatorType)

Gets the arguments for this parameter's validators.

Parameters:

validatorType - String

Returns:

Collection

getValidatorTypes

Collection getValidatorTypes()

All validator types for this attribute.

Returns:

Collection

getValidatorVars

Collection getValidatorVars(JSFParameter ownerParameter)

Gets the validator args for this attribute

Parameters:

ownerParameter - JSFParameter

Returns:

Collection

getValueListDummyValue

String getValueListDummyValue()

The dummy value for a value list.

Returns:

String

getValueListName

String getValueListName(ParameterFacade ownerParameter)

Gets the name of the value list for this parameter; this list stores the possible values that this attribute may be (typically used for the values of a drop-down select list).

Parameters:

ownerParameter - ParameterFacade

Returns:

String

isBackingValueRequired

boolean isBackingValueRequired(FrontEndParameter ownerParameter)

Indicates whether or not the backing value is required for this attribute (depending on the 'ownerParameter').

Parameters:

ownerParameter - FrontEndParameter

Returns:

boolean

isEqualValidator

boolean isEqualValidator()

Indicates whether or not this parameter uses the equal validator.

Returns:

boolean

isInputCheckbox

boolean isInputCheckbox()

Indicates if this parameter represents a checkbox widget.

Returns:

boolean

isInputFile

boolean isInputFile()

Indicates whether or not this is a file input type.

Returns:

boolean

isInputHidden

boolean isInputHidden()

Indicates whether or not this parameter represents a hidden input widget.

Returns:

boolean

isInputMultibox

boolean isInputMultibox()

Indicates whether or not this type represents an input multibox.

Returns:

boolean

isInputRadio

boolean isInputRadio()

Indicates whether or not this parameter should be rendered as an input radio widget.

Returns:

boolean

isInputSecret

boolean isInputSecret()

Indicates whether or not this parameter represents an input "secret" widget (i.e. password).

Returns:

boolean

isInputSelect

boolean isInputSelect()

Indicates whether or not this parameter represents an input select widget.

Returns:

boolean

isInputTable

boolean isInputTable()

Indicates whether or not this is an table input type.

Returns:

boolean

isInputText

boolean isInputText()

Indicates whether or not this parameter should be rendered as a text input widget.

Returns:

boolean

isInputTextarea

boolean isInputTextarea()

Indicates if this parameter represents as an input text area widget.

Returns:

boolean

isInputTypePresent

boolean isInputTypePresent()

Indicates whether or not there is an input type defined for this attribute.

Returns:

boolean

isPlaintext

boolean isPlaintext()

Indicates whether or not this attribute's value should be rendered as plain text (not as a widget).

Returns:

boolean

isSelectable

boolean isSelectable(FrontEndParameter ownerParameter)

Indicates whether or not this attribute is selectable according to its 'ownerParameter'.

Parameters:

ownerParameter - FrontEndParameter

Returns:

boolean

isStrictDateFormat

boolean isStrictDateFormat()

Indicates where or not the date format is to be strictly respected. Otherwise the date formatter used for the representation of this date is to be set to lenient.

Returns:

boolean

isValidationRequired

boolean isValidationRequired()

Indicates whether or not this attribute requires some kind of validation (the collection of validator types is not empty).

Returns:

boolean