org.gvsig.fmap.dal.feature

Interface Feature

All Superinterfaces:

GetItemByKey<java.lang.String,java.lang.Object>, GetItemByKeyWithSize<java.lang.String,java.lang.Object>, GetItemByKeyWithSizeAndGetKeys<java.lang.String,java.lang.Object>, GetKeys<java.lang.String>, Size, SupportToJson

All Known Subinterfaces:

EditableFeature, EditableFeature, Feature

All Known Implementing Classes:

DefaultEditableFeature, DefaultFeature

public interface Feature
extends GetItemByKeyWithSizeAndGetKeys<java.lang.String,java.lang.Object>, SupportToJson

Represents the basic data unit of a tabular structure, equivalent to a record in a data base table. In SIG domain, a Feature is a compound data structure that may contain a geographic component. The conventional term Feature comes from the term cartographic feature and both represent the same concept.

A Feature may contain more than one geometry attribute. In the case there is not any geometry data, the getDefaultGeometry() will return null.

Features are not editable as such. To edit a Feature you have to obtain an editable instance EditableFeature using the method getEditable(). Modify that editable instance and then apply the changes to the Feature. This mechanism is to avoid ambiguity and loosing track on the Feature internal state.

The Feature:

• Has an unique identifier FeatureReference to recognize our Feature from each other from the same data store
• Has a FeatureType that describes the Feature characteristics (attributes, data types, default geometry, validation rules).
• Can obtain a copy of itself.
• Can obtain its default geometry attribute and also a list with all the geometry attributes.
• Can obtain its default Spatial Reference System and also a list with all the SRSs used in the geometry attributes.
• Can obtain the envelope (extent) of the default geometry attribute.
• Can obtain the editable instance of the Feature.
• Has a set of utility methods to read attributes when their type is known, by both index and name.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHECK_BASIC
static int	CHECK_REQUIREDS
static int	CHECK_RULES_AT_EDITING
static int	CHECK_RULES_AT_FINISH

Method Summary

Modifier and Type	Method and Description
ExpressionBuilder	createBuilderFilter()
Expression	createFilter()
java.lang.String	format(int index)
java.lang.String	format(java.lang.String name)
java.lang.Object	get(int index) Returns the value of an attribute given its position.
java.lang.Object	get(java.lang.String name) Returns the value of an attribute given its name.
java.lang.Object[]	getArray(int index) Returns the array value of an attribute given its position.
java.lang.Object[]	getArray(java.lang.String name) Returns the array value of an attribute given its name.
DynObject	getAsDynObject()
boolean	getBoolean(int index) Returns the Boolean value of an attribute given its position.
boolean	getBoolean(java.lang.String name) Returns the Boolean value of an attribute given its name.
boolean	getBooleanOrDefault(int index, boolean defaultValue)
boolean	getBooleanOrDefault(java.lang.String name, boolean defaultValue)
byte	getByte(int index) Returns the byte value of an attribute given its position.
byte	getByte(java.lang.String name) Returns the byte value of an attribute given its name.
byte[]	getByteArray(int index)
byte[]	getByteArray(java.lang.String name)
Feature	getCopy() Creates and returns a copy of this
java.sql.Date	getDate(int index) Returns the Date value of an attribute given its position.
java.sql.Date	getDate(java.lang.String name) Returns the Date value of an attribute given its name.
java.util.Date	getDateOrDefault(int index, java.util.Date defaultValue)
java.util.Date	getDateOrDefault(java.lang.String name, java.util.Date defaultValue)
java.math.BigDecimal	getDecimal(int index) Returns the BigDecimal value of an attribute given its position.
java.math.BigDecimal	getDecimal(java.lang.String name) Returns the BigDecimal value of an attribute given its name.
java.math.BigDecimal	getDecimalOrDefault(int index, java.math.BigDecimal defaultValue)
java.math.BigDecimal	getDecimalOrDefault(java.lang.String name, java.math.BigDecimal defaultValue)
Envelope	getDefaultEnvelope() Envelope (AKA extent or bounding box) of the default geometry attribute.
Geometry	getDefaultGeometry() Returns the value of the default geometry attribute, which is a Geometry.
IProjection	getDefaultSRS() Returns the Spatial Reference System in which is expressed the default geometry attribute.
double	getDouble(int index) Returns the double value of an attribute given its position.
double	getDouble(java.lang.String name) Returns the double value of an attribute given its name.
double	getDoubleOrDefault(int index, double defaultValue)
double	getDoubleOrDefault(java.lang.String name, double defaultValue)
EditableFeature	getEditable() Returns the editable instance of this Feature.
EvaluatorData	getEvaluatorData() This lets Feature be used eaily with Evaluator
java.lang.Object	getExtraValue(int index)
java.lang.Object	getExtraValue(java.lang.String name)
Feature	getFeature(int index) Returns the Feature value of an attribute given its position.
Feature	getFeature(java.lang.String name) Returns the Feature value of an attribute given its name.
float	getFloat(int index) Returns the float value of an attribute given its position.
float	getFloat(java.lang.String name) Returns the float value of an attribute given its name.
float	getFloatOrDefault(int index, float defaultValue)
float	getFloatOrDefault(java.lang.String name, float defaultValue)
Feature	getForeignFeature(java.lang.String attrName)
java.lang.Object	getFromProfile(int index)
java.lang.Object	getFromProfile(java.lang.String name)
java.util.List	getGeometries() Returns a list with the values of this Feature's geometry attributes.
Geometry	getGeometry(int index) Returns the Geometry value of an attribute given its position.
Geometry	getGeometry(java.lang.String name) Returns the Geometry value of an attribute given its name.
int	getInt(int index) Returns the int value of an attribute given its position.
int	getInt(java.lang.String name) Returns the int value of an attribute given its name.
int	getIntOrDefault(int index, int defaultValue)
int	getIntOrDefault(java.lang.String name, int defaultValue)
java.lang.String	getLabelOfValue(java.lang.String name)
long	getLong(int index) Returns the long value of an attribute given its position.
long	getLong(java.lang.String name) Returns the long value of an attribute given its name.
long	getLongOrDefault(int index, long defaultValue)
long	getLongOrDefault(java.lang.String name, long defaultValue)
java.lang.Object	getOrDefault(int index, java.lang.Object defaultValue)
java.lang.Object	getOrDefault(java.lang.String name, DataType type, java.lang.Object defaultValue)
java.lang.Object	getOrDefault(java.lang.String name, int type, java.lang.Object defaultValue)
java.lang.Object	getOrDefault(java.lang.String name, java.lang.Object defaultValue)
FeatureReference	getReference() Returns a unique identifier for this Feature in the associated store.
java.util.List	getSRSs() Returns a list with the Spatial Reference Systems in which are expressed this Feature's geometry attributes.
FeatureStore	getStore() Return the store associated to this feature.
java.lang.String	getString(int index) Returns the String value of an attribute given its position.
java.lang.String	getString(java.lang.String name) Returns the String value of an attribute given its name.
java.lang.String	getStringOrDefault(int index, java.lang.String defaultValue)
java.lang.String	getStringOrDefault(java.lang.String name, java.lang.String defaultValue)
java.sql.Time	getTime(int index)
java.sql.Time	getTime(java.lang.String name)
java.sql.Timestamp	getTimestamp(int index)
java.sql.Timestamp	getTimestamp(java.lang.String name)
FeatureType	getType() Returns the FeatureType that describes the structure of this Feature.
boolean	hasExtraValue(java.lang.String name)
boolean	hasValue(java.lang.String name)
boolean	isBroken()
boolean	isNull(int index)
boolean	isNull(java.lang.String name)
void	setExtraValue(java.lang.String name, java.lang.Object value)
void	validate(int mode)

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

size

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

getKeys

Methods inherited from interface org.gvsig.json.SupportToJson

toJson, toJson, toJsonBuilder, toJsonBuilder

Field Detail

CHECK_RULES_AT_EDITING

static final int CHECK_RULES_AT_EDITING

See Also:

Constant Field Values

CHECK_RULES_AT_FINISH

static final int CHECK_RULES_AT_FINISH

See Also:

Constant Field Values

CHECK_REQUIREDS

static final int CHECK_REQUIREDS

See Also:

Constant Field Values

CHECK_BASIC

static final int CHECK_BASIC

See Also:

Constant Field Values

Method Detail

getReference

FeatureReference getReference()

Returns a unique identifier for this Feature in the associated store.

Returns:

a unique FeatureReference in the associated store

getType

FeatureType getType()

Returns the FeatureType that describes the structure of this Feature.

Returns:

a FeatureType describing this Feature structure.

getCopy

Feature getCopy()

Creates and returns a copy of this

Returns:

a new instance of Feature which is equal to this

validate

void validate(int mode)
       throws DataException

Throws:

DataException

getEditable

EditableFeature getEditable()

Returns the editable instance of this Feature. EditableFeature offers methods for Feature editing.

Returns:

EditableFeature of this

getOrDefault

java.lang.Object getOrDefault(java.lang.String name,
                              java.lang.Object defaultValue)

getOrDefault

java.lang.Object getOrDefault(java.lang.String name,
                              DataType type,
                              java.lang.Object defaultValue)

getOrDefault

java.lang.Object getOrDefault(java.lang.String name,
                              int type,
                              java.lang.Object defaultValue)

getStringOrDefault

java.lang.String getStringOrDefault(java.lang.String name,
                                    java.lang.String defaultValue)

getIntOrDefault

int getIntOrDefault(java.lang.String name,
                    int defaultValue)

getLongOrDefault

long getLongOrDefault(java.lang.String name,
                      long defaultValue)

getFloatOrDefault

float getFloatOrDefault(java.lang.String name,
                        float defaultValue)

getDoubleOrDefault

double getDoubleOrDefault(java.lang.String name,
                          double defaultValue)

getDecimalOrDefault

java.math.BigDecimal getDecimalOrDefault(java.lang.String name,
                                         java.math.BigDecimal defaultValue)

getDateOrDefault

java.util.Date getDateOrDefault(java.lang.String name,
                                java.util.Date defaultValue)

getOrDefault

java.lang.Object getOrDefault(int index,
                              java.lang.Object defaultValue)

getStringOrDefault

java.lang.String getStringOrDefault(int index,
                                    java.lang.String defaultValue)

getIntOrDefault

int getIntOrDefault(int index,
                    int defaultValue)

getLongOrDefault

long getLongOrDefault(int index,
                      long defaultValue)

getFloatOrDefault

float getFloatOrDefault(int index,
                        float defaultValue)

getDoubleOrDefault

double getDoubleOrDefault(int index,
                          double defaultValue)

getDecimalOrDefault

java.math.BigDecimal getDecimalOrDefault(int index,
                                         java.math.BigDecimal defaultValue)

getDateOrDefault

java.util.Date getDateOrDefault(int index,
                                java.util.Date defaultValue)

get

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

Returns the value of an attribute given its name.

Specified by:

get in interface GetItemByKey<java.lang.String,java.lang.Object>

Parameters:

name - a string containing the name of the attribute

Returns:

value of the specified attribute

get

java.lang.Object get(int index)

Returns the value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

isNull

boolean isNull(int index)

isNull

boolean isNull(java.lang.String name)

getInt

int getInt(java.lang.String name)

Returns the int value of an attribute given its name.

Parameters:

name - a string containing the name of the attribute

Returns:

value of the specified attribute

getInt

int getInt(int index)

Returns the int value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

getBoolean

boolean getBoolean(java.lang.String name)

Returns the Boolean value of an attribute given its name.

Parameters:

name - name of the attribute

Returns:

value of the specified attribute

getBooleanOrDefault

boolean getBooleanOrDefault(java.lang.String name,
                            boolean defaultValue)

getBoolean

boolean getBoolean(int index)

Returns the Boolean value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

getBooleanOrDefault

boolean getBooleanOrDefault(int index,
                            boolean defaultValue)

getLong

long getLong(java.lang.String name)

Returns the long value of an attribute given its name.

Parameters:

name - name of the attribute

Returns:

value of the specified attribute

getLong

long getLong(int index)

Returns the long value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

getFloat

float getFloat(java.lang.String name)

Returns the float value of an attribute given its name.

Parameters:

name - name of the attribute

Returns:

value of the specified attribute

getFloat

float getFloat(int index)

Returns the float value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

getDouble

double getDouble(java.lang.String name)

Returns the double value of an attribute given its name.

Parameters:

name - name of the attribute

Returns:

value of the specified attribute

getDouble

double getDouble(int index)

Returns the double value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

getDecimal

java.math.BigDecimal getDecimal(java.lang.String name)

Returns the BigDecimal value of an attribute given its name.

Parameters:

name - name of the attribute

Returns:

value of the specified attribute

getDecimal

java.math.BigDecimal getDecimal(int index)

Returns the BigDecimal value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

getDate

java.sql.Date getDate(java.lang.String name)

Returns the Date value of an attribute given its name.

Parameters:

name - name of the attribute

Returns:

value of the specified attribute

getDate

java.sql.Date getDate(int index)

Returns the Date value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

getTime

java.sql.Time getTime(java.lang.String name)

getTime

java.sql.Time getTime(int index)

getTimestamp

java.sql.Timestamp getTimestamp(java.lang.String name)

getTimestamp

java.sql.Timestamp getTimestamp(int index)

getString

java.lang.String getString(java.lang.String name)

Returns the String value of an attribute given its name.

Parameters:

name - name of the attribute

Returns:

value of the specified attribute

getString

java.lang.String getString(int index)

Returns the String value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

getByte

byte getByte(java.lang.String name)

Returns the byte value of an attribute given its name.

Parameters:

name - name of the attribute

Returns:

value of the specified attribute

getByte

byte getByte(int index)

Returns the byte value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

getGeometry

Geometry getGeometry(java.lang.String name)

Returns the Geometry value of an attribute given its name.

Parameters:

name - name of the attribute

Returns:

value of the specified attribute

getGeometry

Geometry getGeometry(int index)

Returns the Geometry value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

getByteArray

byte[] getByteArray(java.lang.String name)

getByteArray

byte[] getByteArray(int index)

getArray

java.lang.Object[] getArray(java.lang.String name)

Returns the array value of an attribute given its name.

Parameters:

name - name of the attribute

Returns:

value of the specified attribute

getArray

java.lang.Object[] getArray(int index)

Returns the array value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

getFeature

Feature getFeature(java.lang.String name)

Returns the Feature value of an attribute given its name.

Parameters:

name - name of the attribute

Returns:

value of the specified attribute

getFeature

Feature getFeature(int index)

Returns the Feature value of an attribute given its position.

Parameters:

index - position of the attribute

Returns:

value of the specified attribute

getFromProfile

java.lang.Object getFromProfile(int index)

getFromProfile

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

getDefaultEnvelope

Envelope getDefaultEnvelope()

Envelope (AKA extent or bounding box) of the default geometry attribute.

Returns:

Envelope of the default geometry attribute

getDefaultGeometry

Geometry getDefaultGeometry()

Returns the value of the default geometry attribute, which is a Geometry.

Returns:

value of the default geometry attribute

getGeometries

java.util.List getGeometries()

Returns a list with the values of this Feature's geometry attributes.

Returns:

a list with the values of this Feature's geometry attributes

getDefaultSRS

IProjection getDefaultSRS()

Returns the Spatial Reference System in which is expressed the default geometry attribute.

Returns:

A string containing the default geometry attribute SRS.

getSRSs

java.util.List getSRSs()

Returns a list with the Spatial Reference Systems in which are expressed this Feature's geometry attributes.

Returns:

a list with the Spatial Reference Systems.

getAsDynObject

DynObject getAsDynObject()

getEvaluatorData

EvaluatorData getEvaluatorData()

This lets Feature be used eaily with Evaluator

Returns:

An instance of EvaluatorData which returns the data of this feature

getStore

FeatureStore getStore()

Return the store associated to this feature.

Returns:

the FeatureStore of the feature.

getLabelOfValue

java.lang.String getLabelOfValue(java.lang.String name)

getExtraValue

java.lang.Object getExtraValue(int index)

getExtraValue

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

hasExtraValue

boolean hasExtraValue(java.lang.String name)

setExtraValue

void setExtraValue(java.lang.String name,
                   java.lang.Object value)

hasValue

boolean hasValue(java.lang.String name)

format

java.lang.String format(java.lang.String name)

format

java.lang.String format(int index)

getForeignFeature

Feature getForeignFeature(java.lang.String attrName)

createFilter

Expression createFilter()

createBuilderFilter

ExpressionBuilder createBuilderFilter()

isBroken

boolean isBroken()