Class VPFFeatureClass
- All Implemented Interfaces:
SimpleFeatureType
,AttributeType
,ComplexType
,FeatureType
,PropertyType
- Author:
- Jeff Yutzler
-
Constructor Summary
ConstructorsConstructorDescriptionVPFFeatureClass
(VPFCoverage cCoverage, String cName, String cDirectoryName) ConstructorVPFFeatureClass
(VPFCoverage cCoverage, String cName, String cDirectoryName, URI cNamespace) Constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
Equality based on propertyPropertyType.getName()
.int
Returns the number of attributes composing the feature typeThe list of attribute descriptors which make up the feature type.Override and type narrow to Collection.class. The coordinate reference system of the feature.The coverage that owns this feature classHuman readable description of this property type.getDescriptor
(int index) Returns the attribute descriptor at the specified index.getDescriptor
(String name) Returns the attribute descriptor which matches the specified name.getDescriptor
(Name name) Returns the attribute descriptor which matches the specified name.The property descriptor which compose the complex type.The path to the directory that contains this feature classReturns a list of file objectsDescribe the default geometric attribute for this feature.getName()
The name of the property type.List of restrictions used define valid values for properties of this property type.getSuper()
Override ofPropertyType.getSuper()
which type narrows toAttributeType
.getType
(int index) Returns the type of the attribute at the specified index.Returns the type of the attribute which matches the specified name.Returns the type of the attribute which matches the specified name.The local name for this FeatureType.getTypes()
Returns the types of all the attributes which make up the feature.A map of "user data" which enables applications to store "application-specific" information against a property type.int
hashCode()
Hashcode override based onPropertyType.getName()
.boolean
hasNext()
int
Returns the index of the attribute which matches the specified name.int
Returns the index of the attribute which matches the specified name.boolean
Flag indicating if the type is abstract or not.boolean
Features are always identified.boolean
isInline()
Indicates ability of XPath to notice this attribute.readAllRows
(SimpleFeatureType featureType) readNext
(SimpleFeatureType featureType) void
reset()
-
Constructor Details
-
VPFFeatureClass
public VPFFeatureClass(VPFCoverage cCoverage, String cName, String cDirectoryName) throws SchemaException Constructor- Parameters:
cCoverage
- the owning coveragecName
- the name of the classcDirectoryName
- the directory containing the class- Throws:
SchemaException
- For problems making one of the feature classes as a FeatureType.
-
VPFFeatureClass
public VPFFeatureClass(VPFCoverage cCoverage, String cName, String cDirectoryName, URI cNamespace) throws SchemaException Constructor- Parameters:
cCoverage
- the owning coveragecName
- the name of the classcDirectoryName
- the directory containing the classcNamespace
- the namespace to create features with. If null then a default from VPFLibrary.DEFAULTNAMESPACE is assigned.- Throws:
SchemaException
- For problems making one of the feature classes as a FeatureType.
-
-
Method Details
-
reset
public void reset() -
hasNext
public boolean hasNext() -
readAllRows
- Throws:
IOException
-
readNext
-
getCoverage
The coverage that owns this feature class- Returns:
- a
VPFCoverage
object
-
getDirectoryName
The path to the directory that contains this feature class- Returns:
- a
String
value representing the path to the directory.
-
getFileList
Returns a list of file objects- Returns:
- a
List
containingVPFFile
objects.
-
getFeatureType
-
getTypeName
Description copied from interface:SimpleFeatureType
The local name for this FeatureType.Specifically this method returns
getName().getLocalPart().
- Specified by:
getTypeName
in interfaceSimpleFeatureType
- Returns:
- The local name for this FeatureType.
-
getFCTypeName
-
getAttributeCount
public int getAttributeCount()Description copied from interface:SimpleFeatureType
Returns the number of attributes composing the feature typeThis method is convenience for
getAttributes().size()
.- Specified by:
getAttributeCount
in interfaceSimpleFeatureType
- Returns:
- The number of attributes.
-
isAbstract
public boolean isAbstract()Description copied from interface:PropertyType
Flag indicating if the type is abstract or not.- Specified by:
isAbstract
in interfacePropertyType
- Returns:
true
if the type is abstract, otherwisefalse
.
-
getGeometryFactory
- Returns:
- Returns the geometryFactory.
-
equals
Description copied from interface:PropertyType
Equality based on propertyPropertyType.getName()
.- Specified by:
equals
in interfacePropertyType
- Overrides:
equals
in classObject
- Returns:
true
if other is a PropertyType with the same name
-
hashCode
public int hashCode()Description copied from interface:PropertyType
Hashcode override based onPropertyType.getName()
.- Specified by:
hashCode
in interfacePropertyType
- Overrides:
hashCode
in classObject
- Returns:
- getName().hashCode()
-
getDescriptor
Description copied from interface:SimpleFeatureType
Returns the attribute descriptor which matches the specified name.This method is convenience for:
return (AttributeDescriptor) getProperty(name);
This method returns
null
if no such attribute exists.- Specified by:
getDescriptor
in interfaceComplexType
- Specified by:
getDescriptor
in interfaceSimpleFeatureType
- Parameters:
name
- The name of the descriptor to return.- Returns:
- The attribute descriptor matching the specified name, or
null
if no such attribute exists.
-
getDescriptor
Description copied from interface:SimpleFeatureType
Returns the attribute descriptor which matches the specified name.This method is convenience for:
return (AttributeDescriptor) getProperty(name);
This method returns
null
if no such attribute exists.- Specified by:
getDescriptor
in interfaceComplexType
- Specified by:
getDescriptor
in interfaceSimpleFeatureType
- Parameters:
name
- The name of the descriptor to return.- Returns:
- The attribute descriptor matching the specified name, or
null
if no such attribute exists.
-
getDescriptor
Description copied from interface:SimpleFeatureType
Returns the attribute descriptor at the specified index.This method is convenience for:
return (AttributeDescriptor) ((List) getProperties()).get(index);
- Specified by:
getDescriptor
in interfaceSimpleFeatureType
- Parameters:
index
- The index of the descriptor to return.- Returns:
- The attribute descriptor at the specified index.
-
getAttributeDescriptors
Description copied from interface:SimpleFeatureType
The list of attribute descriptors which make up the feature type.This method is a convenience for:
return (List<AttributeDescriptor>) getProperties();
- Specified by:
getAttributeDescriptors
in interfaceSimpleFeatureType
- Returns:
- The ordered list of attribute descriptors.
-
getType
Description copied from interface:SimpleFeatureType
Returns the type of the attribute which matches the specified name.This method is convenience for:
return (AttributeType) getProperty(name).getType();
If there is no such attribute which matches name,
null
is returned.- Specified by:
getType
in interfaceSimpleFeatureType
- Parameters:
name
- The name of the attribute whose type to return.- Returns:
- The attribute type matching the specified name, or
null
.
-
getType
Description copied from interface:SimpleFeatureType
Returns the type of the attribute which matches the specified name.This method is convenience for:
return (AttributeType) getProperty(name).getType();
If there is no such attribute which matches name,
null
is returned.- Specified by:
getType
in interfaceSimpleFeatureType
- Parameters:
name
- The name of the attribute whose type to return.- Returns:
- The attribute type matching the specified name, or
null
.
-
getType
Description copied from interface:SimpleFeatureType
Returns the type of the attribute at the specified index.This method is convenience for:
return (AttributeType)((List)getProperties()).get(index)).getType();
- Specified by:
getType
in interfaceSimpleFeatureType
- Parameters:
index
- The index of the attribute whose type to return.- Returns:
- The attribute type at the specified index.
-
getTypes
Description copied from interface:SimpleFeatureType
Returns the types of all the attributes which make up the feature.This method is convenience for:
List types = new ArrayList(); for (Property p : getProperties()) { types.add(p.getType()); } return types;
- Specified by:
getTypes
in interfaceSimpleFeatureType
- Returns:
- The list of attribute types.
-
getCoordinateReferenceSystem
Description copied from interface:FeatureType
The coordinate reference system of the feature.This value is derived from the default geometry attribute:
((GeometryType)getDefaultGeometry().getType()).getCRS();
This method will return
null
in the case where no default geometric attribute is defined.- Specified by:
getCoordinateReferenceSystem
in interfaceFeatureType
- Returns:
- The coordinate referencing system, or
null
.
-
getGeometryDescriptor
Description copied from interface:FeatureType
Describe the default geometric attribute for this feature.This method returns
null
in the case where no such attribute exists.- Specified by:
getGeometryDescriptor
in interfaceFeatureType
- Returns:
- The descriptor of the default geometry attribute, or
null
.
-
getBinding
Description copied from interface:ComplexType
Override and type narrow to Collection.class. - Specified by:
getBinding
in interfaceComplexType
- Specified by:
getBinding
in interfacePropertyType
- Returns:
- The binding of the property type.
-
getDescriptors
Description copied from interface:ComplexType
The property descriptor which compose the complex type.A complex type can be composed of attributes and associations which means this collection returns instances of
AttributeDescriptor
andAssociationDescriptor
.- Specified by:
getDescriptors
in interfaceComplexType
- Returns:
- Collection of descriptors representing the composition of the complex type.
-
isInline
public boolean isInline()Description copied from interface:ComplexType
Indicates ability of XPath to notice this attribute.This facility is used to "hide" an attribute from XPath searches, while the compelx contents will still be navigated no additional nesting will be considered. It will be as if the content were "folded" inline resulting in a flatter nesting structure.
Construct described using Java Interfaces:
The above is can hold the following information:interface TestSample { String name; List
measurement; } interface Measurement { long timestamp; Point point; long reading; }
Out of the box this is represented to XPath as the following tree:[ name="survey1", measurements=( [timestamp=3,point=(2,3), reading=4200], [timestamp=9,point=(2,4), reading=445600], ) ]
By inlining Measurement we can achive the following:root/name: survey1 root/measurement[0]/timestamp:3 root/measurement[0]/point: (2,3) root/measurement[0]/reading: 4200 root/measurement[1]/timestamp:9 root/measurement[2]/point: (2,4) root/measurement[3]/reading: 445600
root/name: survey1 root/timestamp[0]:3 root/point[0]: (2,3) root/reading[0]: 4200 root/timestamp[1]:9 root/point[1]: (2,4) root/reading[1] 445600
- Specified by:
isInline
in interfaceComplexType
- Returns:
- true if attribute is to be considered transparent by XPath queries
-
getSuper
Description copied from interface:AttributeType
Override ofPropertyType.getSuper()
which type narrows toAttributeType
.- Specified by:
getSuper
in interfaceAttributeType
- Specified by:
getSuper
in interfacePropertyType
- Returns:
- The parent or super type, or
null
. - See Also:
-
isIdentified
public boolean isIdentified()Description copied from interface:FeatureType
Features are always identified.- Specified by:
isIdentified
in interfaceAttributeType
- Specified by:
isIdentified
in interfaceFeatureType
- Returns:
true
- See Also:
-
getDescription
Description copied from interface:PropertyType
Human readable description of this property type.- Specified by:
getDescription
in interfacePropertyType
- Returns:
- Human readable description of this property type.
-
getName
Description copied from interface:PropertyType
The name of the property type.Note that this is not the same name as
Property.getName()
, which is the name of the instance of the type, not the type itself.The returned name is a qualified name made up of two parts. The first a namespace uri (
Name.getNamespaceURI()
, and the second a local part (Name.getLocalPart()
.This value is never
null
.- Specified by:
getName
in interfacePropertyType
- Returns:
- The name of the property type.
-
indexOf
Description copied from interface:SimpleFeatureType
Returns the index of the attribute which matches the specified name.-1 is returned in the instance there is no attribute matching the specified name.
- Specified by:
indexOf
in interfaceSimpleFeatureType
- Parameters:
name
- The name of the attribute whose index to return.- Returns:
- index of named attribute, or -1 if not found.
-
indexOf
Description copied from interface:SimpleFeatureType
Returns the index of the attribute which matches the specified name.-1 is returned in the instance there is no attribute matching the specified name.
- Specified by:
indexOf
in interfaceSimpleFeatureType
- Parameters:
name
- The name of the attribute whose index to return.- Returns:
- index of named attribute, or -1 if not found.
-
getRestrictions
Description copied from interface:PropertyType
List of restrictions used define valid values for properties of this property type.Each restriction is a
Filter
object in which the property is passed through. IfFilter.evaluate(Object)
returnstrue
the restriction is met. Iffalse
is returned then the restriction has not been met and the property should be considered invalid. Remember to check getSuper().getRestrictions() as well.This method returns an empty set in the case of no restrictions and should not return
null
.- Specified by:
getRestrictions
in interfacePropertyType
- Returns:
- List
used to validate allowable values.
-
getUserData
Description copied from interface:PropertyType
A map of "user data" which enables applications to store "application-specific" information against a property type.As an example, consider an application that builds a PropertyType from an xml schema. A useful bit of information to attach to the PropertyType is the original schema itself, in whatever construct it might be stored in:
XSDComplexTypeDefinition complexTypeDef = ...; PropertyType type = buildPropertyType( complexTypeDef ); type.getUserData().put( XSDComplexTypeDefintion.class, complexTypeDef );
- Specified by:
getUserData
in interfacePropertyType
- Returns:
- A map of user data.
-