org.gvsig.fmap.dal.swing.impl.featuretable.table

Class DynFieldFacadeOfAFeatureAttributeDescriptor

java.lang.Object

org.gvsig.fmap.dal.swing.impl.featuretable.table.DynFieldFacadeOfAFeatureAttributeDescriptor

All Implemented Interfaces:

Cloneable, FeatureAttributeDescriptor, DynField

public class DynFieldFacadeOfAFeatureAttributeDescriptor
extends Object
implements FeatureAttributeDescriptor

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
DynFieldFacadeOfAFeatureAttributeDescriptor(DynField field)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowIndexDuplicateds()
boolean	allowNull() Indicates whether this attribute accepts null values.
Object	clone() Creates a copy of the object.
Object	coerce(Object value) Force the type of value to the type of the field.
Object	getAdditionalInfo(String infoName) Returns additional information of the attribute
DynObjectValueItem[]	getAvailableValues() Return the available values for this field.
Class	getClassOfItems() If the field is a container (List, Map or Set) return the java class of its items.
Class	getClassOfValue() Return the java class of the value of the field.
FeatureAttributeDescriptor	getCopy() Returns a clone of this attribute descriptor
DataType	getDataType()
String	getDataTypeName() Returns the name of this attribute's data type.
DateFormat	getDateFormat() If this attribute is of type Date, then this method returns the date format set by the data store.
Object	getDefaultValue() Return the default value used in creation of new objects with this field.
String	getDescription() Return the descripcion associated to this field.
DynField	getElementsType() When a field is of type container, this method return a DynClass that define the type of elements.
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() Gets if the attribute has a FeatureAttributeGetter.
int	getGeometrySubType() If this attribute is a Geometry, this method returns the specific geometry subtype, as defined in Geometry.SUBTYPES.
int	getGeometryType() If this attribute is a Geometry, this method returns the specific geometry type, as defined in Geometry.TYPES.
GeometryType	getGeomType() Returns the GeometryType of the attribute if it is a geometry.
String	getGroup() Return a string that identify a group for this field.
int	getIndex() Returns this attribute relative position within the Feature.
int	getMaximumOccurrences() Returns the maximum number of occurrences of this attribute on a given feature.
Object	getMaxValue()
int	getMinimumOccurrences() Returns the minimum number of occurrences of this attribute on a given feature.
Object	getMinValue()
String	getName() Return the name of the field.
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	getOder() Return the ordinal that identify the order of this field in the DynObject.
int	getPrecision() For attributes of type DataTypes.DOUBLE and DataTypes.FLOAT , this returns the maximum number of places 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.
String	getSubtype() Return the subtype associated to this field.
int	getTheTypeOfAvailableValues()
int	getType() Return the type used in this field.
boolean	isAutomatic() Returns if value is created automatically by the source
boolean	isContainer() Return true if the value of this field is a container.
boolean	isHidden() Inform if this field can be visible or not for the user.
boolean	isIndexAscending()
boolean	isIndexed() Return true if the attribute has and index in the table.
boolean	isMandatory() Return true if this field is mandatory.
boolean	isPersistent() Returns if the field is persistent or volatile.
boolean	isPrimaryKey() Returns true if this attribute forms all or part of the unique identifying value for the feature it is contained by.
boolean	isReadOnly() Returns if the field is readOnly or not.
boolean	isTime() Gets if the attribute is a temporal attribute.
DynField	setAvailableValues(DynObjectValueItem[] values)
DynField	setAvailableValues(List values)
DynField	setClassOfItems(Class theClass) If field type is List, Set or Map, this class is the class of items.
DynField	setClassOfValue(Class theClass) Sets the class used for the values of the field.
DynField	setDefaultDynValue(Object defaultValue)
DynField	setDefaultFieldValue(Object defaultValue) Set the default value used for this field when a new object with this field is created.
DynField	setDescription(String description) Sets the description asociated to this field.
DynField	setElementsType(DynStruct type) Set the type of items when the field is a container.
DynField	setElementsType(int type) Set the type of items when the field is a container.
void	setFeatureAttributeGetter(FeatureAttributeGetter featureAttributeGetter) Sets the FeatureAttributeGetter that is used to update the presentation of a field.
DynField	setGroup(String groupName)
DynField	setHidden(boolean hidden)
DynField	setMandatory(boolean mandatory)
DynField	setMaxValue(Object maxValue)
DynField	setMinValue(Object minValue)
DynField	setOrder(int order)
DynField	setPersistent(boolean persistent) Sets if the field must be persisted or not.
DynField	setReadOnly(boolean isReadOnly) Sets if the field is readOnly or not.
DynField	setSubtype(String subtype) Strings used as subtype for this field.
DynField	setTheTypeOfAvailableValues(int type)
DynField	setType(DataType type)
DynField	setType(int type) Sets the type of the field.
void	validate(Object value) Validate that the value match the properties of the field.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynFieldFacadeOfAFeatureAttributeDescriptor

public DynFieldFacadeOfAFeatureAttributeDescriptor(DynField field)

Method Detail

getCopy

public FeatureAttributeDescriptor getCopy()

Description copied from interface: FeatureAttributeDescriptor

Returns a clone of this attribute descriptor

Specified by:

getCopy in interface FeatureAttributeDescriptor

Returns:

FeatureAttributeDescriptor A new copy of this

getDataTypeName

public String getDataTypeName()

Description copied from interface: FeatureAttributeDescriptor

Returns the name of this attribute's data type.

Specified by:

getDataTypeName in interface FeatureAttributeDescriptor

Returns:

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

getSize

public int getSize()

Description copied from interface: FeatureAttributeDescriptor

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.

Specified by:

getSize in interface FeatureAttributeDescriptor

Returns:

an int indicating the size of the attribute.

getPrecision

public int getPrecision()

Description copied from interface: FeatureAttributeDescriptor

For attributes of type DataTypes.DOUBLE and DataTypes.FLOAT , this returns the maximum number of places after the decimal point. For other types, this must always return zero.

Specified by:

getPrecision in interface FeatureAttributeDescriptor

getObjectClass

public Class getObjectClass()

Description copied from interface: FeatureAttributeDescriptor

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.

Specified by:

getObjectClass in interface FeatureAttributeDescriptor

getMinimumOccurrences

public int getMinimumOccurrences()

Description copied from interface: FeatureAttributeDescriptor

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.

Specified by:

getMinimumOccurrences in interface FeatureAttributeDescriptor

getMaximumOccurrences

public int getMaximumOccurrences()

Description copied from interface: FeatureAttributeDescriptor

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.

Specified by:

getMaximumOccurrences in interface FeatureAttributeDescriptor

isPrimaryKey

public boolean isPrimaryKey()

Description copied from interface: FeatureAttributeDescriptor

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.

Specified by:

isPrimaryKey in interface FeatureAttributeDescriptor

allowNull

public boolean allowNull()

Description copied from interface: FeatureAttributeDescriptor

Indicates whether this attribute accepts null values.

Specified by:

allowNull in interface FeatureAttributeDescriptor

Returns:

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

getEvaluator

public Evaluator getEvaluator()

Description copied from interface: FeatureAttributeDescriptor

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

Specified by:

getEvaluator in interface FeatureAttributeDescriptor

getSRS

public IProjection getSRS()

Description copied from interface: FeatureAttributeDescriptor

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

Specified by:

getSRS in interface FeatureAttributeDescriptor

Returns:

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

getGeometryType

public int getGeometryType()

Description copied from interface: FeatureAttributeDescriptor

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

Specified by:

getGeometryType in interface FeatureAttributeDescriptor

Returns:

One of Geometry.TYPES

getGeometrySubType

public int getGeometrySubType()

Description copied from interface: FeatureAttributeDescriptor

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

Specified by:

getGeometrySubType in interface FeatureAttributeDescriptor

Returns:

One of Geometry.SUBTYPES

getGeomType

public GeometryType getGeomType()

Description copied from interface: FeatureAttributeDescriptor

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

Specified by:

getGeomType in interface FeatureAttributeDescriptor

Returns:

the geometry type

getDateFormat

public DateFormat getDateFormat()

Description copied from interface: FeatureAttributeDescriptor

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

Specified by:

getDateFormat in interface FeatureAttributeDescriptor

Returns:

a date format

getIndex

public int getIndex()

Description copied from interface: FeatureAttributeDescriptor

Returns this attribute relative position within the Feature.

Specified by:

getIndex in interface FeatureAttributeDescriptor

Returns:

an index

getAdditionalInfo

public Object getAdditionalInfo(String infoName)

Description copied from interface: FeatureAttributeDescriptor

Returns additional information of the attribute

Specified by:

getAdditionalInfo in interface FeatureAttributeDescriptor

Returns:

info

isAutomatic

public boolean isAutomatic()

Description copied from interface: FeatureAttributeDescriptor

Returns if value is created automatically by the source

Specified by:

isAutomatic in interface FeatureAttributeDescriptor

isTime

public boolean isTime()

Description copied from interface: FeatureAttributeDescriptor

Gets if the attribute is a temporal attribute.

Specified by:

isTime in interface FeatureAttributeDescriptor

Returns:

true if is a temporal attribute

isIndexed

public boolean isIndexed()

Description copied from interface: FeatureAttributeDescriptor

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

Specified by:

isIndexed in interface FeatureAttributeDescriptor

Returns:

true if indexed.

allowIndexDuplicateds

public boolean allowIndexDuplicateds()

Specified by:

allowIndexDuplicateds in interface FeatureAttributeDescriptor

isIndexAscending

public boolean isIndexAscending()

Specified by:

isIndexAscending in interface FeatureAttributeDescriptor

getFeatureAttributeGetter

public FeatureAttributeGetter getFeatureAttributeGetter()

Description copied from interface: FeatureAttributeDescriptor

Gets if the attribute has a FeatureAttributeGetter.

Specified by:

getFeatureAttributeGetter in interface FeatureAttributeDescriptor

Returns:

a FeatureAttributeGetter or null.

setFeatureAttributeGetter

public void setFeatureAttributeGetter(FeatureAttributeGetter featureAttributeGetter)

Description copied from interface: FeatureAttributeDescriptor

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

Specified by:

setFeatureAttributeGetter in interface FeatureAttributeDescriptor

Parameters:

featureAttributeGetter - the FeatureAttributeGetter to set.

getFeatureAttributeEmulator

public FeatureAttributeEmulator getFeatureAttributeEmulator()

Description copied from interface: FeatureAttributeDescriptor

Gets the attribute emulator associatted FeatureAttributeEmulator to this attribute.

Specified by:

getFeatureAttributeEmulator in interface FeatureAttributeDescriptor

Returns:

a FeatureAttributeEmulator or null.

getName

public String getName()

Description copied from interface: DynField

Return the name of the field.

Specified by:

getName in interface DynField

Returns:

name of the field

getType

public int getType()

Description copied from interface: DynField

Return the type used in this field. The values of type is the same of DataTypes

Specified by:

getType in interface DynField

Returns:

getDataType

public DataType getDataType()

Specified by:

getDataType in interface DynField

getSubtype

public String getSubtype()

Description copied from interface: DynField

Return the subtype associated to this field. The subtype is a string used for the cliente of the field. When the field is of type #DataTypes.DYNOBJECT, the subtype are the fullname of the DynClass.

Specified by:

getSubtype in interface DynField

Returns:

the subtype of the field.

getDescription

public String getDescription()

Description copied from interface: DynField

Return the descripcion associated to this field.

Specified by:

getDescription in interface DynField

Returns:

the description of the field.

getDefaultValue

public Object getDefaultValue()

Description copied from interface: DynField

Return the default value used in creation of new objects with this field.

Specified by:

getDefaultValue in interface DynField

Returns:

defaulr value to use for this field.

getGroup

public String getGroup()

Description copied from interface: DynField

Return a string that identify a group for this field. The groups are defined by the client of the field.

Specified by:

getGroup in interface DynField

Returns:

the group of the field

getOder

public int getOder()

Description copied from interface: DynField

Return the ordinal that identify the order of this field in the DynObject.

Specified by:

getOder in interface DynField

Returns:

the order of field in the DynObject

isMandatory

public boolean isMandatory()

Description copied from interface: DynField

Return true if this field is mandatory.

Specified by:

isMandatory in interface DynField

Returns:

isPersistent

public boolean isPersistent()

Description copied from interface: DynField

Returns if the field is persistent or volatile. The meaning of being persistent depends on how is persisted, but any persistence mechanism must avoid persisting this field value.

Specified by:

isPersistent in interface DynField

Returns:

if the field is to be persisted or not

isHidden

public boolean isHidden()

Description copied from interface: DynField

Inform if this field can be visible or not for the user. This value don't affect the access through the API.

Specified by:

isHidden in interface DynField

Returns:

true if the field is hidden for the user.

isReadOnly

public boolean isReadOnly()

Description copied from interface: DynField

Returns if the field is readOnly or not. The meaning of being readOnly allows to know if the user input to any graphic component associated to this field should be allowed or not.

Specified by:

isReadOnly in interface DynField

Returns:

if the graphic component associated to this field should be readOnly or not

isContainer

public boolean isContainer()

Description copied from interface: DynField

Return true if the value of this field is a container. This method uses the same criteria of the DataType

Specified by:

isContainer in interface DynField

Returns:

true if the field type is a container

getAvailableValues

public DynObjectValueItem[] getAvailableValues()

Description copied from interface: DynField

Return the available values for this field. When assign a value to the field, this value need that exists in this list.

Specified by:

getAvailableValues in interface DynField

Returns:

an array of the available values for the field.

getMinValue

public Object getMinValue()

Specified by:

getMinValue in interface DynField

getMaxValue

public Object getMaxValue()

Specified by:

getMaxValue in interface DynField

getClassOfValue

public Class getClassOfValue()

Description copied from interface: DynField

Return the java class of the value of the field.

Specified by:

getClassOfValue in interface DynField

Returns:

the class of the value

getClassOfItems

public Class getClassOfItems()

Description copied from interface: DynField

If the field is a container (List, Map or Set) return the java class of its items.

Specified by:

getClassOfItems in interface DynField

Returns:

the class of the items

setDescription

public DynField setDescription(String description)

Description copied from interface: DynField

Sets the description asociated to this field.

Specified by:

setDescription in interface DynField

Returns:

this same DynField object

setType

public DynField setType(int type)

Description copied from interface: DynField

Sets the type of the field. The values used are the specified in DataTypes. This method assign the default values of the type for "ClassOfValue" and "subType".

Specified by:

setType in interface DynField

Returns:

this same DynField object

setType

public DynField setType(DataType type)

Specified by:

setType in interface DynField

setSubtype

public DynField setSubtype(String subtype)

Description copied from interface: DynField

Strings used as subtype for this field. This value is used by the client of the object. When the field is a #DataTypes.DYNOBJECT, the subtype is the fullname of the DynStruct.

Specified by:

setSubtype in interface DynField

Returns:

this same DynField object

setDefaultFieldValue

public DynField setDefaultFieldValue(Object defaultValue)

Description copied from interface: DynField

Set the default value used for this field when a new object with this field is created.

Specified by:

setDefaultFieldValue in interface DynField

Returns:

this same DynField object

setGroup

public DynField setGroup(String groupName)

Specified by:

setGroup in interface DynField

setOrder

public DynField setOrder(int order)

Specified by:

setOrder in interface DynField

setMandatory

public DynField setMandatory(boolean mandatory)

Specified by:

setMandatory in interface DynField

setHidden

public DynField setHidden(boolean hidden)

Specified by:

setHidden in interface DynField

setPersistent

public DynField setPersistent(boolean persistent)

Description copied from interface: DynField

Sets if the field must be persisted or not.

Specified by:

setPersistent in interface DynField

Parameters:

persistent - if the field must be persisted or not

Returns:

this same DynField object

See Also:

DynField.isPersistent()

setAvailableValues

public DynField setAvailableValues(DynObjectValueItem[] values)

Specified by:

setAvailableValues in interface DynField

setAvailableValues

public DynField setAvailableValues(List values)

Specified by:

setAvailableValues in interface DynField

setMinValue

public DynField setMinValue(Object minValue)

Specified by:

setMinValue in interface DynField

setMaxValue

public DynField setMaxValue(Object maxValue)

Specified by:

setMaxValue in interface DynField

setClassOfValue

public DynField setClassOfValue(Class theClass)
                         throws DynFieldIsNotAContainerException

Description copied from interface: DynField

Sets the class used for the values of the field.

Specified by:

setClassOfValue in interface DynField

Returns:

this same DynField object

Throws:

DynFieldIsNotAContainerException

setClassOfItems

public DynField setClassOfItems(Class theClass)
                         throws DynFieldIsNotAContainerException

Description copied from interface: DynField

If field type is List, Set or Map, this class is the class of items.

Specified by:

setClassOfItems in interface DynField

Returns:

this same DynField object

Throws:

DynFieldIsNotAContainerException

setReadOnly

public DynField setReadOnly(boolean isReadOnly)

Description copied from interface: DynField

Sets if the field is readOnly or not. The meaning of being readOnly allows to know if the user input to any graphic component associated to this field should be allowed or not.

Specified by:

setReadOnly in interface DynField

Parameters:

isReadOnly - if the graphic component associated to this field should be readOnly or not

Returns:

DynField that define the type of elements.

getElementsType

public DynField getElementsType()

Description copied from interface: DynField

When a field is of type container, this method return a DynClass that define the type of elements. When the type is DYNOBJECT return the DynClass associated to this. Return null if the type not is a container.

Specified by:

getElementsType in interface DynField

Returns:

DynField that define the type of elements.

setElementsType

public DynField setElementsType(int type)
                         throws DynFieldIsNotAContainerException

Description copied from interface: DynField

Set the type of items when the field is a container. El tipo de los elementos de un container esta definido mediante un DynField, que crea con el tipo pasado por parametro y lo devuelve este metodo.

Specified by:

setElementsType in interface DynField

Parameters:

type - de los elementos

Returns:

this same DynField object

Throws:

DynFieldIsNotAContainerException

setElementsType

public DynField setElementsType(DynStruct type)
                         throws DynFieldIsNotAContainerException

Description copied from interface: DynField

Set the type of items when the field is a container. Metodo de utilidad que establece el typo de DYNOBJECT y methe como subtipo el DynStruct pasado como parametro.

Specified by:

setElementsType in interface DynField

Parameters:

type - de los elementos

Returns:

this same DynField object

Throws:

DynFieldIsNotAContainerException

validate

public void validate(Object value)
              throws DynFieldValidateException

Description copied from interface: DynField

Validate that the value match the properties of the field.

Specified by:

validate in interface DynField

Throws:

DynFieldValidateException

coerce

public Object coerce(Object value)
              throws CoercionException

Description copied from interface: DynField

Force the type of value to the type of the field.

Specified by:

coerce in interface DynField

Returns:

new value

Throws:

CoercionException

getTheTypeOfAvailableValues

public int getTheTypeOfAvailableValues()

Specified by:

getTheTypeOfAvailableValues in interface DynField

Returns:

setDefaultDynValue

public DynField setDefaultDynValue(Object defaultValue)

Specified by:

setDefaultDynValue in interface DynField

Returns:

setTheTypeOfAvailableValues

public DynField setTheTypeOfAvailableValues(int type)

Specified by:

setTheTypeOfAvailableValues in interface DynField

Returns:

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class Object

Returns:

a copy of the object

Throws:

CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.

See Also:

Object#clone()}.