org.gvsig.fmap.dal.feature

Interface FeatureType

All Superinterfaces:

DynClass, DynStruct, DynStruct_v2, GetItem<FeatureAttributeDescriptor>, GetItemWithSize<FeatureAttributeDescriptor>, GetItemWithSizeAndIterator<FeatureAttributeDescriptor>, IsEmpty, java.lang.Iterable<FeatureAttributeDescriptor>, Size, SupportToJson, Tagged, UnmodifiableBasicCollection<FeatureAttributeDescriptor>, UnmodifiableBasicList<FeatureAttributeDescriptor>

All Known Subinterfaces:

EditableFeatureType, FeatureType

All Known Implementing Classes:

DefaultEditableFeatureType, DefaultFeatureType

public interface FeatureType
extends DynClass, DynStruct_v2, UnmodifiableBasicList<FeatureAttributeDescriptor>, SupportToJson

This interface provides all the information that describes the structure of a type of feature, methods for managing it and also offers a variety of utility methods for simplicity's sake.

The relevant information that compounds a FeatureType includes:

• FeatureAttributeDescriptor(s)
• FeatureRule(s)
• Its size
• Its SRS(s)
• Its identifier
• Whether features of this type have an OID or not (identifier assigned by the store).

Methods for management include:

• Obtaining its editable instance.
• Obtaining an iterator over its attributes.
• Knowing whether this FeatureType has any associated evaluator for calculated attributes.

Utility methods include:

• Getting a copy of the FeatureType.
• Getting the default geometry attribute.
• Getting the default spatial reference system.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FeatureType.FeatureTypeChanged

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Predicate<FeatureAttributeDescriptor>	ALL_FILTER
static java.util.function.Predicate<FeatureAttributeDescriptor>	BASIC_TYPES_FILTER

Fields inherited from interface org.gvsig.tools.util.UnmodifiableBasicList

EMPTY_UNMODIFIABLEBASICLIST

Fields inherited from interface org.gvsig.tools.util.GetItemWithSizeAndIterator

EMPTY_GETITEMWITHSIZEANDITERATOR

Method Summary

Modifier and Type	Method and Description
boolean	allowAutomaticValues() Incicates if attibutes with automatic values are allowed in the source
void	copyFrom(FeatureType other)
FeatureAttributeDescriptor	get(int index) Returns an attribute descriptor given its index
java.lang.Object	get(java.lang.String name) Returns an attribute descriptor given its name.
java.lang.Iterable<FeatureAttributeDescriptor>	getAllAttributeDescriptors()
FeatureStore	getAsFeatureStore()
FeatureAttributeDescriptor	getAttributeDescriptor(int index) Returns a FeatureAttributeDescriptor given the attribute index.
FeatureAttributeDescriptor	getAttributeDescriptor(java.lang.String name) Returns a FeatureAttributeDescriptor given the attribute name, or null if an attribute with the given name does not exist.
FeatureAttributeDescriptor	getAttributeDescriptorFromAll(java.lang.String name)
FeatureAttributeDescriptor[]	getAttributeDescriptors() Returns an Array of the FeatureAttributeDescriptor
java.lang.String	getAttributeName(int index) Returns the name of the given the attribute index.
FeatureType	getCopy() Returns a new copy of this FeatureType
FeatureAttributeDescriptor	getDefaultGeometryAttribute() Returns the default geometry FeatureAttributeDescriptor.
int	getDefaultGeometryAttributeIndex() Returns the index of the attribute that will be used as default geometry attribute.
java.lang.String	getDefaultGeometryAttributeName() Returns the name of the attribute that will be used as default geometry attribute for those processes that require a geometry (for instance rendering).
IProjection	getDefaultSRS() Returns the SRS in which the default geometry attribute is expressed.
FeatureAttributeDescriptor	getDefaultTimeAttribute() Returns the default time FeatureAttributeDescriptor.
int	getDefaultTimeAttributeIndex() Returns the index of the attribute that will be used as default geometry attribute.
java.lang.String	getDefaultTimeAttributeName() Returns the name of the attribute that will be used as default geometry attribute for those processes that require a geometry (for instance rendering).
EditableFeatureType	getEditable() Returns an editable instance of this FeatureType.
FeatureExtraColumns	getExtraColumns()
java.util.List<FeatureAttributeDescriptor>	getFilteredAttributes(java.util.function.Predicate<FeatureAttributeDescriptor> filter, int max)
java.lang.String	getId() Returns this FeatureType identifier.
int	getIndex(java.lang.String name) Given the name of an attribute, this method returns its position in this FeatureType.
java.lang.String	getNewFieldName()
FeatureType	getOriginalFeatureType() Return the original feature type of this type.
FeatureAttributeDescriptor[]	getPrimaryKey() Returns an Array of the FeatureAttributeDescriptor that compounds the primary key.
java.util.List<FeatureAttributeDescriptor>	getRecentUseds()
FeatureRules	getRules() Returns a FeatureRules containing all rules applicable to features of this type.
java.util.List	getSRSs() Returns a list with the SRSs in which this FeatureType geometries are expressed.
FeatureStore	getStore() Return the store associated to this type.
boolean	hasEvaluators() Indicates whether this FeatureType has any assigned Evaluator(s).
boolean	hasOID() Indicates whether Feature(s) of this FeatureType have an OID defined.
boolean	hasOnlyMetadataChanges(FeatureType other)
boolean	hasPrimaryKey()
boolean	isCheckFeaturesAtFinishEditing()
boolean	isCheckFeaturesAtInsert()
boolean	isEmpty()
java.util.Iterator	iterator() Returns an iterator over this FeatureType's attributes.
int	size() Returns this FeatureType size.
boolean	supportReferences()
void	writeAsDALFile(java.io.File file)
void	writeAsDALFile(java.io.File file, java.lang.String format)

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

addDynMethod, getDeclaredDynMethod, getDeclaredDynMethods, getDynMethod, getDynMethod, getDynMethods, getSuperDynClasses, removeDynMethod

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

addDynField, getLabel, getTags, setLabel

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

addDynField, addDynFieldArray, addDynFieldBoolean, addDynFieldChoice, addDynFieldChoice, addDynFieldDate, addDynFieldDouble, addDynFieldFile, addDynFieldFloat, addDynFieldFolder, addDynFieldInt, addDynFieldList, addDynFieldLong, addDynFieldMap, addDynFieldObject, addDynFieldRange, addDynFieldRange, addDynFieldSet, addDynFieldSingle, addDynFieldSingle, addDynFieldString, addDynFieldURI, addDynFieldURL, extend, extend, extend, getDeclaredDynField, getDeclaredDynFields, getDescription, getDynField, getDynFields, getFullName, getName, getNamespace, getSuperDynStructs, isExtendable, isInstance, newInstance, remove, removeDynField, setDescription, setNamespace, validate

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

toList

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

isEmpty, isEmpty, isEmptyQuietly

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.gvsig.json.SupportToJson

toJson, toJson, toJsonBuilder, toJsonBuilder

Field Detail

BASIC_TYPES_FILTER

static final java.util.function.Predicate<FeatureAttributeDescriptor> BASIC_TYPES_FILTER

ALL_FILTER

static final java.util.function.Predicate<FeatureAttributeDescriptor> ALL_FILTER

Method Detail

getCopy

FeatureType getCopy()

Returns a new copy of this FeatureType

Returns:

a new copy of this FeatureType

copyFrom

void copyFrom(FeatureType other)

getRules

FeatureRules getRules()

Returns a FeatureRules containing all rules applicable to features of this type.

Returns:

a FeatureRules containing all rules applicable to features of this type.

getEditable

EditableFeatureType getEditable()

Returns an editable instance of this FeatureType. Any modifications on a FeatureType must be done through its editable instance.

Returns:

the editable instance of this FeatureType.

See Also:

EditableFeatureType

getIndex

int getIndex(java.lang.String name)

Given the name of an attribute, this method returns its position in this FeatureType.

Parameters:

name - of the attribute

Returns:

position of the attribute

get

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

Returns an attribute descriptor given its name.

Parameters:

name - of the attribute

Returns:

descriptor of the attribute, a FeatureAttributeDescriptor.

get

FeatureAttributeDescriptor get(int index)

Returns an attribute descriptor given its index

Specified by:

get in interface GetItem<FeatureAttributeDescriptor>

Parameters:

index - of the attribute

Returns:

descriptor of the attribute, a FeatureAttributeDescriptor

getAttributeDescriptor

FeatureAttributeDescriptor getAttributeDescriptor(java.lang.String name)

Returns a FeatureAttributeDescriptor given the attribute name, or null if an attribute with the given name does not exist.

Parameters:

name - of the attribute

Returns:

a FeatureAttributeDescriptor

getAttributeDescriptorFromAll

FeatureAttributeDescriptor getAttributeDescriptorFromAll(java.lang.String name)

getAttributeDescriptor

FeatureAttributeDescriptor getAttributeDescriptor(int index)

Returns a FeatureAttributeDescriptor given the attribute index.

Parameters:

index - of the attribute

Returns:

a FeatureAttributeDescriptor

getAttributeName

java.lang.String getAttributeName(int index)

Returns the name of the given the attribute index. If the index is incorrect, return null.

Parameters:

index - of the attribute

Returns:

a String with the name of attribute

iterator

java.util.Iterator iterator()

Returns an iterator over this FeatureType's attributes. Elements returned by this iterator are of type FeatureAttributeDescriptor.

Specified by:

iterator in interface java.lang.Iterable<FeatureAttributeDescriptor>

Returns:

An iterator over this FeatureType's FeatureAttributeDescriptors.

size

int size()

Returns this FeatureType size. The size of a FeatureType is determined by its number of attributes.

Specified by:

size in interface Size

Returns:

this FeatureType size, defined as the number of attributes it is composed of.

isEmpty

boolean isEmpty()

Specified by:

isEmpty in interface IsEmpty

getId

java.lang.String getId()

Returns this FeatureType identifier. This identifier must always be equal to a store.

Returns:

the identifier.

getDefaultGeometryAttributeName

java.lang.String getDefaultGeometryAttributeName()

Returns the name of the attribute that will be used as default geometry attribute for those processes that require a geometry (for instance rendering).

Returns:

name of the default geometry attribute.

getDefaultGeometryAttributeIndex

int getDefaultGeometryAttributeIndex()

Returns the index of the attribute that will be used as default geometry attribute.

Returns:

index of the default geometry attribute.

getSRSs

java.util.List getSRSs()

Returns a list with the SRSs in which this FeatureType geometries are expressed. Normally there may be one SRS for each attribute of type Geometry.

Returns:

a list with the SRS in which this FeatureType geometries are expressed.

getDefaultSRS

IProjection getDefaultSRS()

Returns the SRS in which the default geometry attribute is expressed.

Returns:

the SRS in which the default geometry attribute is expressed, null if not has a default geometry attribute.

hasEvaluators

boolean hasEvaluators()

Indicates whether this FeatureType has any assigned Evaluator(s). Evaluators are used to obtain the values for calculated attributes.

Returns:

true if this FeatureType has any assigned Evaluator(s).

hasOID

boolean hasOID()

Indicates whether Feature(s) of this FeatureType have an OID defined. An OID is the Feature unique identifier. Some stores provide their own OIDs which are always unique (such as Postgre) while others don't support this concept and then it is the library who creates runtime ad-hoc OIDs as it see fits, but then integrity of this OIDs among different work sessions cannot be guaranteed (this is the case for shape files).

Returns:

true if this FeatureType has an OID defined, false otherwise.

allowAutomaticValues

boolean allowAutomaticValues()

Incicates if attibutes with automatic values are allowed in the source

Returns:

true if source supports this feature, false otherwise

getAttributeDescriptors

FeatureAttributeDescriptor[] getAttributeDescriptors()

Returns an Array of the FeatureAttributeDescriptor

Returns:

getPrimaryKey

FeatureAttributeDescriptor[] getPrimaryKey()

Returns an Array of the FeatureAttributeDescriptor that compounds the primary key. If not have primary keys return a empty array.

Returns:

hasPrimaryKey

boolean hasPrimaryKey()

supportReferences

boolean supportReferences()

getDefaultGeometryAttribute

FeatureAttributeDescriptor getDefaultGeometryAttribute()

Returns the default geometry FeatureAttributeDescriptor. Return null if it's not set

Returns:

getDefaultTimeAttribute

FeatureAttributeDescriptor getDefaultTimeAttribute()

Returns the default time FeatureAttributeDescriptor. Return null if it's not set.

Returns:

the default time attribute

getDefaultTimeAttributeName

java.lang.String getDefaultTimeAttributeName()

Returns the name of the attribute that will be used as default geometry attribute for those processes that require a geometry (for instance rendering).

Returns:

name of the default geometry attribute.

getDefaultTimeAttributeIndex

int getDefaultTimeAttributeIndex()

Returns the index of the attribute that will be used as default geometry attribute.

Returns:

index of the default geometry attribute.

getStore

FeatureStore getStore()

Return the store associated to this type.

Returns:

the FeatureStore of the type.

getFilteredAttributes

java.util.List<FeatureAttributeDescriptor> getFilteredAttributes(java.util.function.Predicate<FeatureAttributeDescriptor> filter,
                                                                 int max)

getRecentUseds

java.util.List<FeatureAttributeDescriptor> getRecentUseds()

getAsFeatureStore

FeatureStore getAsFeatureStore()

getNewFieldName

java.lang.String getNewFieldName()

getOriginalFeatureType

FeatureType getOriginalFeatureType()

Return the original feature type of this type. It will return Null when the store it's in not editing mode or the featureType has not been change

Returns:

the original FeatureType of the type.

hasOnlyMetadataChanges

boolean hasOnlyMetadataChanges(FeatureType other)

writeAsDALFile

void writeAsDALFile(java.io.File file)

writeAsDALFile

void writeAsDALFile(java.io.File file,
                    java.lang.String format)

getExtraColumns

FeatureExtraColumns getExtraColumns()

getAllAttributeDescriptors

java.lang.Iterable<FeatureAttributeDescriptor> getAllAttributeDescriptors()

isCheckFeaturesAtFinishEditing

boolean isCheckFeaturesAtFinishEditing()

isCheckFeaturesAtInsert

boolean isCheckFeaturesAtInsert()