Package org.gvsig.fmap.dal.feature

Interface EditableFeatureAttributeDescriptor

All Superinterfaces:

Cloneable, org.gvsig.tools.lang.Cloneable, org.gvsig.tools.dynobject.DynField, org.gvsig.tools.dynobject.DynField_LabelAttribute, org.gvsig.tools.dynobject.DynField_v2, FeatureAttributeDescriptor, org.gvsig.tools.util.LabeledValue<FeatureAttributeDescriptor>, org.gvsig.tools.persistence.Persistent, org.gvsig.json.SupportFromJson, org.gvsig.json.SupportToJson, org.gvsig.tools.dynobject.Tagged

public interface EditableFeatureAttributeDescriptor
extends FeatureAttributeDescriptor, org.gvsig.json.SupportFromJson

This interface represents a FeatureAttributeDescriptor in editable state. To edit a FeatureAttributeDescriptor you have to obtain its instance of EditableFeatureAttributeDescriptor and then perform editing operations on it. Once you have completed the editing you can save the changes to the original FeatureAttributeDescriptor. This is the only way to edit a FeatureAttributeDescriptor.

Nested Class Summary

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

org.gvsig.tools.dynobject.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	Description
void	checkIntegrity()	Checks attribute integrity
EditableForeingKey	getForeingKey()
String	getOriginalName()	Returns the attribute descriptor's name before it was changed or null if never changed
EditableFeatureAttributeDescriptor	set(String name, Object value)
EditableFeatureAttributeDescriptor	setAdditionalInfo(String infoName, Object value)	Deprecated.
EditableFeatureAttributeDescriptor	setAdditionalInfo(String infoName, String value)	Sets additional information of the attribute
EditableFeatureAttributeDescriptor	setAllowIndexDuplicateds(boolean allowDuplicateds)
EditableFeatureAttributeDescriptor	setAllowNull(boolean allowNull)	Sets whether the related FeatureAttribute can have a null value
EditableFeatureAttributeDescriptor	setAvailableValuesFilter(org.gvsig.expressionevaluator.Expression filter)
EditableFeatureAttributeDescriptor	setAvoidCachingAvailableValues(boolean avoidCachingAvailableValues)
EditableFeatureAttributeDescriptor	setDataProfileName(String dataProfile)
EditableFeatureAttributeDescriptor	setDataType(int type)	Sets the data type
EditableFeatureAttributeDescriptor	setDataType(org.gvsig.tools.dataTypes.DataType dataType)
EditableFeatureAttributeDescriptor	setDateFormat(DateFormat dateFormat)	If this attribute is of type Date, then this method set the date format set by the data store.
EditableFeatureAttributeDescriptor	setDefaultFormat(String format)
EditableFeatureAttributeDescriptor	setDefaultValue(Object defaultValue)	Sets the default value
EditableFeatureAttributeDescriptor	setDisplaySize(int size)	Set the required bytes to store this attribute.
EditableFeatureAttributeDescriptor	setEvaluator(org.gvsig.tools.evaluator.Evaluator evaluator)	Sets the expression evaluator that the FeatureAttribute will use
EditableFeatureAttributeDescriptor	setFeatureAttributeEmulator(String expression)
EditableFeatureAttributeDescriptor	setFeatureAttributeEmulator(org.gvsig.expressionevaluator.Expression expression)
EditableFeatureAttributeDescriptor	setFeatureAttributeEmulator(FeatureAttributeEmulator featureAttributeEmulator)	Sets the FeatureAttributeEmulator that is used to update the presentation of a field.
EditableFeatureAttributeDescriptor	setForeingkey(boolean isForeingkey, boolean isClosedList, String tableName, String codeName, String labelFormula)
EditableFeatureAttributeDescriptor	setGeometrySubType(int geometrySubType)	Sets the geometry subtype
EditableFeatureAttributeDescriptor	setGeometryType(int geometryType)	Sets the geometry type
EditableFeatureAttributeDescriptor	setGeometryType(int geometryType, int geometrySubType)
EditableFeatureAttributeDescriptor	setGeometryType(String geometryType)	Sets the geometry type and subtype.
EditableFeatureAttributeDescriptor	setGeometryType(org.gvsig.fmap.geom.type.GeometryType geometryType)	Sets the geometry type
EditableFeatureAttributeDescriptor	setInterval(org.gvsig.timesupport.Interval interval)
EditableFeatureAttributeDescriptor	setIsAutomatic(boolean isAutomatic)	Sets whether the related FeatureAttribute is part of the FeatureType's primary key
EditableFeatureAttributeDescriptor	setIsIndexAscending(boolean ascending)
EditableFeatureAttributeDescriptor	setIsIndexed(boolean isIndexed)	Sets if this attribute is indexed in the table.
EditableFeatureAttributeDescriptor	setIsPrimaryKey(boolean isPrimaryKey)	Sets whether the related FeatureAttribute is part of the FeatureType's primary key
EditableFeatureAttributeDescriptor	setIsReadOnly(boolean isReadOnly)	Sets whether the related FeatureAttribute is read only
EditableFeatureAttributeDescriptor	setIsTime(boolean isTime)	Sets is the attribute is a temporal attribute.
EditableFeatureAttributeDescriptor	setLocale(Locale locale)
EditableFeatureAttributeDescriptor	setMaximumOccurrences(int maximumOccurrences)	Sets the maximum number of occurrences
EditableFeatureAttributeDescriptor	setMinimumOccurrences(int minimumOccurrences)	Sets the number of minimum occurrences
EditableFeatureAttributeDescriptor	setName(String name)	Sets the name
EditableFeatureAttributeDescriptor	setObjectClass(Class theClass)	Sets the Class to which the related FeatureAttribute can be cast
EditableFeatureAttributeDescriptor	setPrecision(int precision)	Sets the precision
EditableFeatureAttributeDescriptor	setRoundMode(int roundMode)
EditableFeatureAttributeDescriptor	setScale(int scale)
EditableFeatureAttributeDescriptor	setSize(int size)	Sets the size.
EditableFeatureAttributeDescriptor	setSRS(String SRS)
EditableFeatureAttributeDescriptor	setSRS(org.gvsig.crs.projection.lib.Projection SRS)	Sets the SRS.
EditableFeatureAttributeDescriptor	setTag(String name, Object value)

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

clone

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.dynobject.DynField_LabelAttribute

getLabel, getShortLabel, setLabel, setShortLabel

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.fmap.dal.feature.FeatureAttributeDescriptor

allowIndexDuplicateds, allowNull, format, get, getAdditionalInfo, getAvailableValuesExpression, getAvailableValuesFilter, getCoercion, getCoercionContext, getCopy, getDataProfile, getDataProfileName, getDataTypeName, getDateFormat, getDefaultFormat, getDefaultValueCoerced, getDisplaySize, getEvaluator, getFeatureAttributeEmulator, getFeatureAttributeGetter, getFeatureType, getFullDataTypeName, getGeometrySubType, getGeometryType, getGeomType, getIndex, getInterval, getLabelOfValue, getLocale, getLocalizedLabel, getLocalizedShortLabel, getMathContext, getMaximumOccurrences, getMinimumOccurrences, getObjectClass, getPrecision, getRequiredFieldNames, getRoundMode, getScale, getSize, getSRS, getStore, hasAvailableValues, hasConstantAvailableValues, hasDataProfile, hasDescription, hasLabel, hasOnlyMetadataChanges, hasShortLabel, isAutomatic, isAvoidCachingAvailableValues, isComputed, isForeingKey, isInAvailableValues, isIndexAscending, isIndexed, isPrimaryKey, isTime, recentUsed, setAvailableValuesExpression, setAvailableValuesExpression, setFeatureAttributeGetter

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

getLabel, getValue, toString

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

loadFromState, saveToState

Methods inherited from interface org.gvsig.json.SupportFromJson

fromJson

Methods inherited from interface org.gvsig.json.SupportToJson

toJson, toJson, toJsonBuilder, toJsonBuilder

Method Details

checkIntegrity

void checkIntegrity()
             throws AttributeFeatureTypeIntegrityException

Checks attribute integrity

Throws:

AttributeFeatureTypeIntegrityException

getForeingKey

EditableForeingKey getForeingKey()

Specified by:

getForeingKey in interface FeatureAttributeDescriptor

setName

EditableFeatureAttributeDescriptor setName(String name)

Sets the name

Parameters:

name - to set

Returns:

this

setDataType

EditableFeatureAttributeDescriptor setDataType(int type)

Sets the data type

Parameters:

type - one of the constants defined in DataTypes

Returns:

this

setDataType

EditableFeatureAttributeDescriptor setDataType(org.gvsig.tools.dataTypes.DataType dataType)

setDataProfileName

EditableFeatureAttributeDescriptor setDataProfileName(String dataProfile)

setSize

EditableFeatureAttributeDescriptor setSize(int size)

Sets the size. Used for arrays (byte, char/string,...)

Parameters:

size - a size of type int

Returns:

this

setDisplaySize

EditableFeatureAttributeDescriptor setDisplaySize(int size)

Set the required bytes to store this attribute. This value is dependent of the store type.

Parameters:

size -

Returns:

setPrecision

EditableFeatureAttributeDescriptor setPrecision(int precision)

Sets the precision

Parameters:

precision - of type int

Returns:

this

setScale

EditableFeatureAttributeDescriptor setScale(int scale)

setObjectClass

EditableFeatureAttributeDescriptor setObjectClass(Class theClass)

Sets the Class to which the related FeatureAttribute can be cast

Parameters:

theClass - Class to which the related FeatureAttribute can be cast

Returns:

this

setMinimumOccurrences

EditableFeatureAttributeDescriptor setMinimumOccurrences(int minimumOccurrences)

Sets the number of minimum occurrences

Parameters:

minimumOccurrences -

Returns:

this

setMaximumOccurrences

EditableFeatureAttributeDescriptor setMaximumOccurrences(int maximumOccurrences)

Sets the maximum number of occurrences

Parameters:

maximumOccurrences -

Returns:

setIsPrimaryKey

EditableFeatureAttributeDescriptor setIsPrimaryKey(boolean isPrimaryKey)

Sets whether the related FeatureAttribute is part of the FeatureType's primary key

Parameters:

isPrimaryKey - true if is part of the primary key

Returns:

this

setEvaluator

EditableFeatureAttributeDescriptor setEvaluator(org.gvsig.tools.evaluator.Evaluator evaluator)

Sets the expression evaluator that the FeatureAttribute will use

Parameters:

evaluator - an implementation of DAL's Evaluator interface

Returns:

this

setAvoidCachingAvailableValues

EditableFeatureAttributeDescriptor setAvoidCachingAvailableValues(boolean avoidCachingAvailableValues)

setFeatureAttributeEmulator

EditableFeatureAttributeDescriptor setFeatureAttributeEmulator(FeatureAttributeEmulator featureAttributeEmulator)

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

Parameters:

featureAttributeEmulator - the FeatureAttributeEmulator to set.

Returns:

setFeatureAttributeEmulator

EditableFeatureAttributeDescriptor setFeatureAttributeEmulator(org.gvsig.expressionevaluator.Expression expression)

setFeatureAttributeEmulator

EditableFeatureAttributeDescriptor setFeatureAttributeEmulator(String expression)

setIsReadOnly

EditableFeatureAttributeDescriptor setIsReadOnly(boolean isReadOnly)

Sets whether the related FeatureAttribute is read only

Parameters:

isReadOnly -

Returns:

this

setAllowNull

EditableFeatureAttributeDescriptor setAllowNull(boolean allowNull)

Sets whether the related FeatureAttribute can have a null value

Parameters:

allowNull - a boolean value determining whether the FeatureAttribute can be null

Returns:

this

setSRS

EditableFeatureAttributeDescriptor setSRS(org.gvsig.crs.projection.lib.Projection SRS)

Sets the SRS.

Parameters:

SRS -

Returns:

setSRS

EditableFeatureAttributeDescriptor setSRS(String SRS)

setInterval

EditableFeatureAttributeDescriptor setInterval(org.gvsig.timesupport.Interval interval)

setGeometryType

EditableFeatureAttributeDescriptor setGeometryType(int geometryType)

Sets the geometry type

Parameters:

geometryType -

Returns:

this

setGeometrySubType

EditableFeatureAttributeDescriptor setGeometrySubType(int geometrySubType)

Sets the geometry subtype

Parameters:

geometrySubType -

Returns:

this

setGeometryType

EditableFeatureAttributeDescriptor setGeometryType(org.gvsig.fmap.geom.type.GeometryType geometryType)

Sets the geometry type

Parameters:

geometryType -

Returns:

this

setGeometryType

EditableFeatureAttributeDescriptor setGeometryType(String geometryType)

Sets the geometry type and subtype. The format is: {geometryType}{sep}[geometrySubtype} where:

• geometryType is the name of the type of geometry.
• sep is a character from ":/-!;#@".
• geometrySubtype is the name of the subtype of geometry.

Parameters:

geometryType -

Returns:

setGeometryType

EditableFeatureAttributeDescriptor setGeometryType(int geometryType,
 int geometrySubType)

setDefaultValue

EditableFeatureAttributeDescriptor setDefaultValue(Object defaultValue)

Sets the default value

Parameters:

defaultValue -

Returns:

this

setAdditionalInfo

EditableFeatureAttributeDescriptor setAdditionalInfo(String infoName,
 String value)

Sets additional information of the attribute

Parameters:

infoName -

value -

Returns:

setAdditionalInfo

@Deprecated
EditableFeatureAttributeDescriptor setAdditionalInfo(String infoName,
 Object value)

Deprecated.

setIsAutomatic

EditableFeatureAttributeDescriptor setIsAutomatic(boolean isAutomatic)

Sets whether the related FeatureAttribute is part of the FeatureType's primary key

Parameters:

isAutomatic - true if is part of the primary key

Returns:

this

setIsTime

EditableFeatureAttributeDescriptor setIsTime(boolean isTime)

Sets is the attribute is a temporal attribute.

Parameters:

isTime - true if the attribute is temporal

Returns:

this

setIsIndexed

EditableFeatureAttributeDescriptor setIsIndexed(boolean isIndexed)

Sets if this attribute is indexed in the table.

Parameters:

isIndexed -

Returns:

this

setAllowIndexDuplicateds

EditableFeatureAttributeDescriptor setAllowIndexDuplicateds(boolean allowDuplicateds)

setIsIndexAscending

EditableFeatureAttributeDescriptor setIsIndexAscending(boolean ascending)

getOriginalName

String getOriginalName()

Returns the attribute descriptor's name before it was changed or null if never changed

Returns:

setDateFormat

EditableFeatureAttributeDescriptor setDateFormat(DateFormat dateFormat)

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

Parameters:

dateFormat -

Returns:

set

EditableFeatureAttributeDescriptor set(String name,
 Object value)

setRoundMode

EditableFeatureAttributeDescriptor setRoundMode(int roundMode)

setLocale

EditableFeatureAttributeDescriptor setLocale(Locale locale)

setForeingkey

EditableFeatureAttributeDescriptor setForeingkey(boolean isForeingkey,
 boolean isClosedList,
 String tableName,
 String codeName,
 String labelFormula)

setTag

EditableFeatureAttributeDescriptor setTag(String name,
 Object value)

setAvailableValuesFilter

EditableFeatureAttributeDescriptor setAvailableValuesFilter(org.gvsig.expressionevaluator.Expression filter)

setDefaultFormat

EditableFeatureAttributeDescriptor setDefaultFormat(String format)