com.vividsolutions.jump.feature

Class FeatureSchema

java.lang.Object

com.vividsolutions.jump.feature.FeatureSchema

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AttributeMapping.CombinedSchema

public class FeatureSchema
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Metadata for a FeatureCollection: attribute names and types.

See Also:

FeatureCollection, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FeatureSchema()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(java.lang.String attributeName, AttributeType attributeType) Adds an attribute with the given case-sensitive name.
void	addDynamicAttribute(java.lang.String attributeName, AttributeType attributeType, Operation operation) Add a dynamic attribute to this FeatureSchema A dynamic attribute is a readOnly attribute which is dynamically evaluated on demand.
void	addExternalPrimaryKey(java.lang.String attributeName, AttributeType attributeType) Add an attribute containing an external identifier.
java.lang.Object	clone() Return a deep copy of this FeatureSchema.
boolean	equals(java.lang.Object other) Returns whether the two FeatureSchemas have the same attribute names with the same types and in the same order.
boolean	equals(java.lang.Object other, boolean orderMatters) Returns whether the two FeatureSchemas have the same attribute names with the same types and (optionally) in the same order.
int	getAttributeCount() Returns the total number of spatial and non-spatial attributes in this FeatureSchema.
int	getAttributeIndex(java.lang.String attributeName) Returns the zero-based index of the attribute with the given name (case-sensitive)
java.lang.String	getAttributeName(int attributeIndex) Returns the (case-sensitive) name of the attribute at the given zero-based index.
AttributeType	getAttributeType(int attributeIndex) Returns whether the attribute at the given zero-based index is a string, integer, double, etc.
AttributeType	getAttributeType(java.lang.String attributeName) Returns whether the attribute with the given name (case-sensitive) is a string, integer, double, etc.
CoordinateSystem	getCoordinateSystem()
int	getExternalPrimaryKeyIndex() Returns the attribute index of the externalId attribute, or -1 if there is no externalId.
int	getGeometryIndex() Returns the attribute index of the Geometry, or -1 if there is no Geometry attribute
Operation	getOperation(int attributeIndex) Get the operation in charge of the attribute value evaluation.
boolean	hasAttribute(java.lang.String attributeName) Returns whether this FeatureSchema has an attribute with this name
boolean	isAttributeReadOnly(int attributeIndex) Returns the "readonly" status of the attribute specified by the attributeIndex.
boolean	isOperation(int attributeIndex) Returns true if an attribute must be computed on the fly by an Operation.
void	removeExternalPrimaryKey()
void	setAttributeReadOnly(int attributeIndex, boolean isReadOnly) Sets the "readonly" status of the attribute specified by the attributeIndex.
FeatureSchema	setCoordinateSystem(CoordinateSystem coordinateSystem) Sets the CoordinateSystem associated with this FeatureSchema, but does not perform any reprojection.
void	setExternalPrimaryKeyIndex(int index)
void	setOperation(int attributeIndex, Operation operation) Set the Operation in charge of computing this attribute.
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FeatureSchema

public FeatureSchema()

Method Detail

clone

public java.lang.Object clone()

Return a deep copy of this FeatureSchema.

Overrides:

clone in class java.lang.Object

getAttributeIndex

public int getAttributeIndex(java.lang.String attributeName)

Returns the zero-based index of the attribute with the given name (case-sensitive)

Throws:

java.lang.IllegalArgumentException - if attributeName is unrecognized

hasAttribute

public boolean hasAttribute(java.lang.String attributeName)

Returns whether this FeatureSchema has an attribute with this name

Parameters:

attributeName - the name to look up

Returns:

whether this FeatureSchema has an attribute with this name

getGeometryIndex

public int getGeometryIndex()

Returns the attribute index of the Geometry, or -1 if there is no Geometry attribute

getAttributeName

public java.lang.String getAttributeName(int attributeIndex)

Returns the (case-sensitive) name of the attribute at the given zero-based index.

getAttributeType

public AttributeType getAttributeType(int attributeIndex)

Returns whether the attribute at the given zero-based index is a string, integer, double, etc.

getAttributeType

public AttributeType getAttributeType(java.lang.String attributeName)

Returns whether the attribute with the given name (case-sensitive) is a string, integer, double, etc.

getAttributeCount

public int getAttributeCount()

Returns the total number of spatial and non-spatial attributes in this FeatureSchema. There are 0 or 1 spatial attributes and 0 or more non-spatial attributes.

addAttribute

public void addAttribute(java.lang.String attributeName,
                AttributeType attributeType)

Adds an attribute with the given case-sensitive name.

Throws:

com.vividsolutions.jts.util.AssertionFailedException - if a second Geometry is being added

addDynamicAttribute

public void addDynamicAttribute(java.lang.String attributeName,
                       AttributeType attributeType,
                       Operation operation)

Add a dynamic attribute to this FeatureSchema A dynamic attribute is a readOnly attribute which is dynamically evaluated on demand.

Since:

1.6

equals

public boolean equals(java.lang.Object other)

Returns whether the two FeatureSchemas have the same attribute names with the same types and in the same order.

Overrides:

equals in class java.lang.Object

equals

public boolean equals(java.lang.Object other,
             boolean orderMatters)

Returns whether the two FeatureSchemas have the same attribute names with the same types and (optionally) in the same order. WARNING : be aware that equals method compare neither isReadOnly attribute nor operation. Not sure if it must be added.

setCoordinateSystem

public FeatureSchema setCoordinateSystem(CoordinateSystem coordinateSystem)

Sets the CoordinateSystem associated with this FeatureSchema, but does not perform any reprojection.

Returns:

this FeatureSchema

getCoordinateSystem

public CoordinateSystem getCoordinateSystem()

See Also:

setCoordinateSystem(CoordinateSystem)

isAttributeReadOnly

public boolean isAttributeReadOnly(int attributeIndex)

Returns the "readonly" status of the attribute specified by the attributeIndex.

A return result of TRUE means the a user will not be able to edit the attribute in the layer's attribute table, even though the layer's "editable" flag has been set to TRUE

Parameters:

attributeIndex - The index of the attribute in question.

Returns:

TRUE if the specified attribute has been previously set as readonly.

See Also:

setAttributeReadOnly(int, boolean)

setAttributeReadOnly

public void setAttributeReadOnly(int attributeIndex,
                        boolean isReadOnly)

Sets the "readonly" status of the attribute specified by the attributeIndex.

Some schemas (like those that represent database tables) can have attributes that should not be modified (like primary keys). Setting such an attribute as readonly means a user will not be able to edit the attribute in the layer's attribute table, even though the layer's "editable" flag has been set to TRUE

Parameters:

attributeIndex - The index of the attribute to set

isReadOnly - A flag that indicates whether the specified attribute should be considered "readonly".

See Also:

isAttributeReadOnly(int)

isOperation

public boolean isOperation(int attributeIndex)

Returns true if an attribute must be computed on the fly by an Operation.

Parameters:

attributeIndex - The index of the attribute in question.

Returns:

TRUE if the specified attribute is dynamically computed.

setOperation

public void setOperation(int attributeIndex,
                Operation operation)

Set the Operation in charge of computing this attribute.

Parameters:

attributeIndex - index of the attribute to compute.

operation - operation in charge of the evaluation.

getOperation

public Operation getOperation(int attributeIndex)

Get the operation in charge of the attribute value evaluation.

Parameters:

attributeIndex - index of the attribute.

getExternalPrimaryKeyIndex

public int getExternalPrimaryKeyIndex()

Returns the attribute index of the externalId attribute, or -1 if there is no externalId.

setExternalPrimaryKeyIndex

public void setExternalPrimaryKeyIndex(int index)

removeExternalPrimaryKey

public void removeExternalPrimaryKey()

addExternalPrimaryKey

public void addExternalPrimaryKey(java.lang.String attributeName,
                         AttributeType attributeType)

Add an attribute containing an external identifier. This attribute is read-only fo OpenJUMP. It is the responsability of the external datastore to write in this attribute.

Parameters:

attributeName - name of the external id

attributeType - type of the external id

Throws:

java.lang.IllegalArgumentException - if the attributeType of the id is not one of Integer, String or Object (for Long)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object