org.gvsig.fmap.dal.feature

Interface FeatureAttributeDescriptor

All Superinterfaces:

java.lang.Cloneable, DynField, DynField_LabelAttribute, DynField_v2, LabeledValue<FeatureAttributeDescriptor>, Persistent, SupportToJson, Tagged

All Known Subinterfaces:

EditableFeatureAttributeDescriptor

All Known Implementing Classes:

DefaultEditableFeatureAttributeDescriptor, DefaultFeatureAttributeDescriptor, DynFieldFacadeOfAFeatureAttributeDescriptor

public interface FeatureAttributeDescriptor
extends DynField_v2, LabeledValue<FeatureAttributeDescriptor>, Persistent, SupportToJson

A feature attribute descriptor contains information about one of the attributes in a feature, such as its name, data type or precision.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gvsig.tools.dynobject.DynField_v2

DynField_v2.AvailableValuesProvider

Field Summary

Fields inherited from interface org.gvsig.tools.dynobject.DynField

ANY, CHOICE, RANGE, RELATION_TYPE_AGGREGATE, RELATION_TYPE_AGGREGATE_WITH_COMPOSITION, RELATION_TYPE_COLLABORATION, RELATION_TYPE_COLLABORATION_WITH_COMPOSITION, RELATION_TYPE_COMPOSITION, RELATION_TYPE_IDENTITY, RELATION_TYPE_NONE

Method Summary

Modifier and Type	Method and Description
boolean	allowIndexDuplicateds()
boolean	allowNull() Indicates whether this attribute accepts null values.
java.lang.String	format(java.lang.Object value)
java.lang.Object	get(java.lang.String name) Retrieve the value of the attribute "name".
java.lang.String	getAdditionalInfo(java.lang.String infoName) Returns additional information of the attribute
Expression	getAvailableValuesExpression()
Expression	getAvailableValuesFilter()
Coercion	getCoercion() Return a Coercion to convert a value to the type of this attribute.
CoercionContext	getCoercionContext() Return a CoercionContext for this attribute.
FeatureAttributeDescriptor	getCopy() Returns a clone of this attribute descriptor
DataProfile	getDataProfile()
java.lang.String	getDataProfileName()
java.lang.String	getDataTypeName() Returns the name of this attribute's data type.
java.text.DateFormat	getDateFormat() If this attribute is of type Date, then this method returns the date format set by the data store.
java.lang.String	getDefaultFormat()
java.lang.Object	getDefaultValueCoerced() Return the default value coerced to the data type of attribute.
int	getDisplaySize() Return the designated column normal maximum width in characters.
Evaluator	getEvaluator() Returns an evaluator that will be used to calculate the value of this attribute
FeatureAttributeEmulator	getFeatureAttributeEmulator() Gets the attribute emulator associatted FeatureAttributeEmulator to this attribute.
FeatureAttributeGetter	getFeatureAttributeGetter() Deprecated. use getFeatureAttributeGetterAndSetter
FeatureType	getFeatureType()
ForeingKey	getForeingKey()
int	getGeometrySubType() Deprecated. use getGeomType() instead. To be removed in gvSIG 2.1.
int	getGeometryType() Deprecated. use getGeomType() instead. To be removed in gvSIG 2.1.
GeometryType	getGeomType() Returns the GeometryType of the attribute if it is a geometry.
int	getIndex() Returns this attribute relative position within the Feature.
Interval	getInterval()
java.lang.String	getLabelOfValue(java.lang.Object value)
java.util.Locale	getLocale() Returns the Locale associated with this attribute.
java.lang.String	getLocalizedLabel()
java.lang.String	getLocalizedShortLabel()
java.math.MathContext	getMathContext() For attributes of type DataTypes.DECIMAL, this returns the MathContext associated to this.
int	getMaximumOccurrences() Returns the maximum number of occurrences of this attribute on a given feature.The vast majority of data sources and data consumers will only function with this value being one.
int	getMinimumOccurrences() Returns the minimum number of occurrences of this attribute on a given feature.
java.lang.Class	getObjectClass() For attributes of type DataTypes.OBJECT, this returns the Java Class object that class or interface that all values of this attribute can be cast to.
int	getPrecision() For attributes of type DataTypes.DECIMAL, this returns the maximum number of digits.
java.lang.String[]	getRequiredFieldNames()
int	getRoundMode() Returns the rounding mode to use when a value is converted to the attribute's data type.
int	getScale() For attributes of type DataTypes.DECIMAL, this returns the maximum number of digits after the decimal point.
int	getSize() Returns a number that indicates the size of this attribute.
IProjection	getSRS() If this attribute is a Geometry, this method returns its Spatial Reference System.
FeatureStore	getStore() Return the store associated to this attribute descriptor.
boolean	hasAvailableValues()
boolean	hasConstantAvailableValues()
boolean	hasDataProfile()
boolean	hasDescription()
boolean	hasLabel()
boolean	hasOnlyMetadataChanges(FeatureAttributeDescriptor other)
boolean	hasShortLabel()
boolean	isAutomatic() Returns if value is created automatically by the source
boolean	isAvoidCachingAvailableValues()
boolean	isComputed() Return true if the attribute has an evaluator o an emulator.
boolean	isForeingKey()
boolean	isInAvailableValues(java.lang.Object valueToCheck)
boolean	isIndexAscending()
boolean	isIndexed() Return true if the attribute has and index in the table.
boolean	isPrimaryKey() Returns true if this attribute forms all or part of the unique identifying value for the feature it is contained by.
boolean	isTime() Gets if the attribute is a temporal attribute.
void	recentUsed()
FeatureAttributeDescriptor	setAvailableValuesExpression(Expression expression)
FeatureAttributeDescriptor	setAvailableValuesExpression(java.lang.String expression)
void	setFeatureAttributeGetter(FeatureAttributeGetter featureAttributeGetter) Deprecated. use setFeatureAttributeGetterAndSetter

Methods inherited from interface org.gvsig.tools.dynobject.DynField_v2

copyFrom, getAvailableValues, getAvailableValuesMethod, getCalculatedValue, getCalculateMethod, getClassNameOfItems, getClassNameOfValue, getClassOfItems, getCoercedDefaultValue, getDefaultValueSupplier, getDynClassOfItems, getDynClassOfValue, getRelationType, getTags, getTypeOfItems, getValidateElements, isAvailableValuesCalculated, isCalculated, setAvailableValues, setCalculateMethod, setClassOfItems, setClassOfItems, setClassOfItems, setClassOfValue, setClassOfValue, setDefaultValueSupplier, setRelationType, setTypeOfItems, setValidateElements

Methods inherited from interface org.gvsig.tools.dynobject.DynField_LabelAttribute

getLabel, getShortLabel, setLabel, setShortLabel

Methods inherited from interface org.gvsig.tools.dynobject.DynField

coerce, getAvailableValues, getClassOfValue, getDataType, getDefaultValue, getDescription, getElementsType, getGroup, getMaxValue, getMinValue, getName, getOder, getSubtype, getTheTypeOfAvailableValues, getType, isContainer, isHidden, isMandatory, isPersistent, isReadOnly, setAvailableValues, setAvailableValues, setClassOfValue, setDefaultDynValue, setDefaultFieldValue, setDescription, setElementsType, setElementsType, setGroup, setHidden, setMandatory, setMaxValue, setMinValue, setOrder, setPersistent, setReadOnly, setSubtype, setTheTypeOfAvailableValues, setType, setType, validate

Methods inherited from interface org.gvsig.tools.lang.Cloneable

clone, cloneQuietly, cloneQuietly

Methods inherited from interface org.gvsig.tools.util.LabeledValue

getLabel, getValue, label, toString

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Methods inherited from interface org.gvsig.json.SupportToJson

toJson, toJson, toJsonBuilder, toJsonBuilder

Method Detail

getCopy

FeatureAttributeDescriptor getCopy()

Returns a clone of this attribute descriptor

Returns:

FeatureAttributeDescriptor A new copy of this

getDataTypeName

java.lang.String getDataTypeName()

Returns the name of this attribute's data type.

Returns:

a string containing the name of this attribute's data type.

hasDataProfile

boolean hasDataProfile()

getDataProfileName

java.lang.String getDataProfileName()

getDataProfile

DataProfile getDataProfile()

getSize

int getSize()

Returns a number that indicates the size of this attribute. See the documentation for the various constants of DataTypes for how to interpret this value. As an example, when the data type is DataTypes.STRING, this value indicates the maximum length of the string.

Returns:

an int indicating the size of the attribute.

getDisplaySize

int getDisplaySize()

Return the designated column normal maximum width in characters.

Returns:

getPrecision

int getPrecision()

For attributes of type DataTypes.DECIMAL, this returns the maximum number of digits. For other types, this must always return zero.

Returns:

getScale

int getScale()

For attributes of type DataTypes.DECIMAL, this returns the maximum number of digits after the decimal point. For other types, this must always return zero.

Returns:

getMathContext

java.math.MathContext getMathContext()

For attributes of type DataTypes.DECIMAL, this returns the MathContext associated to this. For other types return MathContext.UNLIMITED.

Returns:

getCoercionContext

CoercionContext getCoercionContext()

Return a CoercionContext for this attribute.

Returns:

the CoercionContext

getCoercion

Coercion getCoercion()

Return a Coercion to convert a value to the type of this attribute.

Returns:

the Coercion.

getRoundMode

int getRoundMode()

Returns the rounding mode to use when a value is converted to the attribute's data type. It will only be used for Float, Double and Decimal data types.

Returns:

getLocale

java.util.Locale getLocale()

Returns the Locale associated with this attribute. It is usually used to format and recognize dates and decimal numbers. The default Locale will be Locale. ENGLISH

Returns:

getObjectClass

java.lang.Class getObjectClass()

For attributes of type DataTypes.OBJECT, this returns the Java Class object that class or interface that all values of this attribute can be cast to.

Returns:

getMinimumOccurrences

int getMinimumOccurrences()

Returns the minimum number of occurrences of this attribute on a given feature. The vast majority of data sources and data consumers will only function with this value being zero or one. If the minimum number of occurrences is zero, this is equivalent, in SQL terms, to the attribute being nillable.

Returns:

getMaximumOccurrences

int getMaximumOccurrences()

Returns the maximum number of occurrences of this attribute on a given feature.The vast majority of data sources and data consumers will only function with this value being one. A value of Integer.MAX_VALUE indicates that the maximum number of occurrences is unbounded.

Returns:

isPrimaryKey

boolean isPrimaryKey()

Returns true if this attribute forms all or part of the unique identifying value for the feature it is contained by. The primary key attributes uniquely identify this feature from other features of the same type. This is different from the Feature.getReference(), which must uniquely identify the Feature among all feature types.

Returns:

allowNull

boolean allowNull()

Indicates whether this attribute accepts null values.

Returns:

true if this attribute can be null, false if not.

getEvaluator

Evaluator getEvaluator()

Returns an evaluator that will be used to calculate the value of this attribute

Returns:

getSRS

IProjection getSRS()

If this attribute is a Geometry, this method returns its Spatial Reference System.

Returns:

the SRS if this attribute is a Geometry, otherwise this method returns null.

getGeometryType

int getGeometryType()

Deprecated. use getGeomType() instead. To be removed in gvSIG 2.1.

If this attribute is a Geometry, this method returns the specific geometry type, as defined in Geometry.TYPES.

Returns:

One of Geometry.TYPES

getGeometrySubType

int getGeometrySubType()

Deprecated. use getGeomType() instead. To be removed in gvSIG 2.1.

If this attribute is a Geometry, this method returns the specific geometry subtype, as defined in Geometry.SUBTYPES.

Returns:

One of Geometry.SUBTYPES

getGeomType

GeometryType getGeomType()

Returns the GeometryType of the attribute if it is a geometry.

Returns:

the geometry type

getDateFormat

java.text.DateFormat getDateFormat()

If this attribute is of type Date, then this method returns the date format set by the data store.

Returns:

a date format

getDefaultValueCoerced

java.lang.Object getDefaultValueCoerced()

Return the default value coerced to the data type of attribute. Return null if can't coerce.

Returns:

default value or null.

getIndex

int getIndex()

Returns this attribute relative position within the Feature.

Returns:

an index

getAdditionalInfo

java.lang.String getAdditionalInfo(java.lang.String infoName)

Returns additional information of the attribute

Parameters:

infoName -

Returns:

info

isAutomatic

boolean isAutomatic()

Returns if value is created automatically by the source

Returns:

isTime

boolean isTime()

Gets if the attribute is a temporal attribute.

Returns:

true if is a temporal attribute

getInterval

Interval getInterval()

isIndexed

boolean isIndexed()

Return true if the attribute has and index in the table.

Returns:

true if indexed.

allowIndexDuplicateds

boolean allowIndexDuplicateds()

isIndexAscending

boolean isIndexAscending()

isForeingKey

boolean isForeingKey()

getForeingKey

ForeingKey getForeingKey()

getFeatureAttributeGetter

FeatureAttributeGetter getFeatureAttributeGetter()

Deprecated. use getFeatureAttributeGetterAndSetter

Gets if the attribute has a FeatureAttributeGetter.

Returns:

a FeatureAttributeGetter or null.

setFeatureAttributeGetter

void setFeatureAttributeGetter(FeatureAttributeGetter featureAttributeGetter)

Deprecated. use setFeatureAttributeGetterAndSetter

Sets the FeatureAttributeGetter that is used to update the presentation of a field.

Parameters:

featureAttributeGetter - the FeatureAttributeGetter to set.

getFeatureAttributeEmulator

FeatureAttributeEmulator getFeatureAttributeEmulator()

Gets the attribute emulator associatted FeatureAttributeEmulator to this attribute.

Returns:

a FeatureAttributeEmulator or null.

isComputed

boolean isComputed()

Return true if the attribute has an evaluator o an emulator.

Returns:

getStore

FeatureStore getStore()

Return the store associated to this attribute descriptor.

Returns:

the FeatureStore of the attribute descriptor.

getFeatureType

FeatureType getFeatureType()

getRequiredFieldNames

java.lang.String[] getRequiredFieldNames()

recentUsed

void recentUsed()

getLocalizedShortLabel

java.lang.String getLocalizedShortLabel()

Specified by:

getLocalizedShortLabel in interface DynField_LabelAttribute

getLocalizedLabel

java.lang.String getLocalizedLabel()

Specified by:

getLocalizedLabel in interface DynField_LabelAttribute

getLabelOfValue

java.lang.String getLabelOfValue(java.lang.Object value)

hasOnlyMetadataChanges

boolean hasOnlyMetadataChanges(FeatureAttributeDescriptor other)

hasLabel

boolean hasLabel()

hasShortLabel

boolean hasShortLabel()

hasDescription

boolean hasDescription()

get

java.lang.Object get(java.lang.String name)

Retrieve the value of the attribute "name".

Parameters:

name -

Returns:

hasConstantAvailableValues

boolean hasConstantAvailableValues()

isAvoidCachingAvailableValues

boolean isAvoidCachingAvailableValues()

getAvailableValuesExpression

Expression getAvailableValuesExpression()

setAvailableValuesExpression

FeatureAttributeDescriptor setAvailableValuesExpression(java.lang.String expression)

setAvailableValuesExpression

FeatureAttributeDescriptor setAvailableValuesExpression(Expression expression)

isInAvailableValues

boolean isInAvailableValues(java.lang.Object valueToCheck)

hasAvailableValues

boolean hasAvailableValues()

getAvailableValuesFilter

Expression getAvailableValuesFilter()

getDefaultFormat

java.lang.String getDefaultFormat()

format

java.lang.String format(java.lang.Object value)