org.gvsig.fmap.dal.feature

Interface EditableFeatureType

All Superinterfaces:

DynClass, DynStruct, FeatureType, Iterable<FeatureAttributeDescriptor>

All Known Implementing Classes:

DefaultEditableFeatureType

public interface EditableFeatureType
extends FeatureType

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

Method Summary

Modifier and Type	Method and Description
EditableFeatureAttributeDescriptor	add(String name, int type) Adds an attribute to this EditableFeatureType.
EditableFeatureAttributeDescriptor	add(String name, int type, Evaluator evaluator) Adds a calculated attribute to this EditableFeatureType.
EditableFeatureAttributeDescriptor	add(String name, int type, FeatureAttributeEmulator emulator)
EditableFeatureAttributeDescriptor	add(String name, int type, int size) Adds an attribute to this EditableFeatureType.
EditableFeatureAttributeDescriptor	add(String name, String type)
EditableFeatureAttributeDescriptor	add(String name, String type, int size)
EditableFeatureAttributeDescriptor	getEditableAttributeDescriptor(int index) Returns a FeatureAttributeDescriptor given the attribute index.
EditableFeatureAttributeDescriptor	getEditableAttributeDescriptor(String name) Returns a FeatureAttributeDescriptor given the attribute name, or null if an attribute with the given name does not exist.
FeatureType	getNotEditableCopy() Returns a copy of the associated FeatureType.
FeatureType	getSource() Returns the associated FeatureType.
boolean	remove(EditableFeatureAttributeDescriptor attribute) Removes an attribute from this EditableFeatureType, given a reference to its descriptor.
Object	remove(int index) Removes an attribute given its index
Object	remove(String name) Removes an attribute given its name
void	setDefaultGeometryAttributeName(String name) Sets the default geometry attribute name
void	setDefaultGeometryType(int type, int subType)
void	setDefaultTimeAttributeName(String name) Sets the default time attribute name
void	setHasOID(boolean hasOID) Sets whether this EditableFeatureType has an OID.

Methods inherited from interface org.gvsig.fmap.dal.feature.FeatureType

allowAutomaticValues, get, get, getAttributeDescriptor, getAttributeDescriptor, getAttributeDescriptors, getCopy, getDefaultGeometryAttribute, getDefaultGeometryAttributeIndex, getDefaultGeometryAttributeName, getDefaultSRS, getDefaultTimeAttribute, getEditable, getId, getIndex, getPrimaryKey, getRules, getSRSs, hasEvaluators, hasOID, iterator, size

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

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 java.lang.Iterable

forEach, spliterator

Method Detail

setDefaultGeometryAttributeName

void setDefaultGeometryAttributeName(String name)

Sets the default geometry attribute name

Parameters:

name - string containing the default geometry attribute name

setDefaultGeometryType

void setDefaultGeometryType(int type,
                            int subType)

remove

boolean remove(EditableFeatureAttributeDescriptor attribute)

Removes an attribute from this EditableFeatureType, given a reference to its descriptor.

Parameters:

attribute - descriptor of the attribute to remove

Returns:

true if the attribute was removed successfully, false if not.

remove

Object remove(String name)

Removes an attribute given its name

Parameters:

name - string containing the name of the attribute to be removed

Returns:

remove

Object remove(int index)

Removes an attribute given its index

Parameters:

index - position of the attribute to be removed

Returns:

add

EditableFeatureAttributeDescriptor add(String name,
                                       int type)

Adds an attribute to this EditableFeatureType.

Parameters:

name - string containing the name of the attribute

type - data type of the attribute (one from DataTypes)

Returns:

a new EditableFeatureAttributeDescriptor

add

EditableFeatureAttributeDescriptor add(String name,
                                       String type)

add

EditableFeatureAttributeDescriptor add(String name,
                                       int type,
                                       int size)

Adds an attribute to this EditableFeatureType.

Parameters:

name - string containing the name of the attribute

type - data type of the attribute (one from DataTypes)

size - size of the attribute.

Returns:

a new EditableFeatureAttributeDescriptor

add

EditableFeatureAttributeDescriptor add(String name,
                                       String type,
                                       int size)

add

EditableFeatureAttributeDescriptor add(String name,
                                       int type,
                                       Evaluator evaluator)

Adds a calculated attribute to this EditableFeatureType.

Parameters:

name - string containing the name of the attribute

type - data type of the attribute (one from DataTypes)

evaluator - an evaluator containing the desired expression

Returns:

a new EditableFeatureAttributeDescriptor

add

EditableFeatureAttributeDescriptor add(String name,
                                       int type,
                                       FeatureAttributeEmulator emulator)

getSource

FeatureType getSource()

Returns the associated FeatureType.

Returns:

the associated FeatureType

getNotEditableCopy

FeatureType getNotEditableCopy()

Returns a copy of the associated FeatureType.

Returns:

associated FeatureType

setHasOID

void setHasOID(boolean hasOID)

Sets whether this EditableFeatureType has an OID. An OID is a unique serializable reference to a feature (a primary key of sorts that may or may not be defined by the store). If the store does not define this OID then it will be generated by the feature reference itself. Its main use is to provide a way to persist data associated to a feature by this OID.

Parameters:

hasOID - true if it has an OID, or false if not.

setDefaultTimeAttributeName

void setDefaultTimeAttributeName(String name)

Sets the default time attribute name

Parameters:

name - string containing the default time attribute name

getEditableAttributeDescriptor

EditableFeatureAttributeDescriptor getEditableAttributeDescriptor(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

getEditableAttributeDescriptor

EditableFeatureAttributeDescriptor getEditableAttributeDescriptor(int index)

Returns a FeatureAttributeDescriptor given the attribute index.

Parameters:

index - of the attribute

Returns:

a FeatureAttributeDescriptor