Class DefaultFeatureTypeInfo
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.content.DefaultFeatureTypeInfo
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject
@TitleProperty(name="featureTypeName")
@UML(identifier="MD_FeatureTypeInfo",
specification=ISO_19115)
public class DefaultFeatureTypeInfo
extends ISOMetadata
Information about the occurring feature type.
Note on International Standard versions
This class is derived from a new type defined in the ISO 19115 international standard published in 2014, while GeoAPI 3.0 is based on the version published in 2003. Consequently this implementation class does not yet implement a GeoAPI interface, but is expected to do so after the next GeoAPI releases. When the interface will become available, all references to this implementation class in Apache SIS will be replaced be references to the
This class is derived from a new type defined in the ISO 19115 international standard published in 2014, while GeoAPI 3.0 is based on the version published in 2003. Consequently this implementation class does not yet implement a GeoAPI interface, but is expected to do so after the next GeoAPI releases. When the interface will become available, all references to this implementation class in Apache SIS will be replaced be references to the
FeatureTypeInfo interface.
Limitations
- Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
- Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases.
Serialization support is appropriate for short term storage or RMI between applications running the
same version of Apache SIS. For long term storage, use
XMLinstead.
- Since:
- 0.5
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate IntegerNumber of occurrence of feature instances for this feature types.private org.opengis.util.GenericNameName of the feature type.private static final longSerial number for compatibility with different versions.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty feature type info.Constructs a new instance initialized with the values from the specified metadata object.DefaultFeatureTypeInfo(org.opengis.util.GenericName featureTypeName) Constructs a feature type info initialized to the specified name. -
Method Summary
Modifier and TypeMethodDescriptionReturns the number of occurrence of feature instances for this feature types, ornullif none.org.opengis.util.GenericNameReturns the name of the feature type.voidsetFeatureInstanceCount(Integer newValue) Sets a new number of occurrence of feature instances for this feature types.voidsetFeatureTypeName(org.opengis.util.GenericName newValue) Sets the name of the feature type.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for compatibility with different versions.- See Also:
-
featureTypeName
private org.opengis.util.GenericName featureTypeNameName of the feature type. -
featureInstanceCount
Number of occurrence of feature instances for this feature types.
-
-
Constructor Details
-
DefaultFeatureTypeInfo
public DefaultFeatureTypeInfo()Constructs an initially empty feature type info. -
DefaultFeatureTypeInfo
public DefaultFeatureTypeInfo(org.opengis.util.GenericName featureTypeName) Constructs a feature type info initialized to the specified name.- Parameters:
featureTypeName- name of the feature type.
-
DefaultFeatureTypeInfo
Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.Note on properties validation: This constructor does not verify the property values of the given metadata (e.g. whether it contains unexpected negative values). This is because invalid metadata exist in practice, and verifying their validity in this copy constructor is often too late. Note that this is not the only hole, as invalid metadata instances can also be obtained by unmarshalling an invalid XML document.- Parameters:
object- the metadata to copy values from, ornullif none.
-
-
Method Details
-
getFeatureTypeName
@UML(identifier="featureTypeName", obligation=MANDATORY, specification=ISO_19115) public org.opengis.util.GenericName getFeatureTypeName()Returns the name of the feature type.- Returns:
- name of the feature type.
- See Also:
-
setFeatureTypeName
public void setFeatureTypeName(org.opengis.util.GenericName newValue) Sets the name of the feature type.- Parameters:
newValue- the new name.
-
getFeatureInstanceCount
@ValueRange(minimum=1.0) @UML(identifier="featureInstanceCount", obligation=OPTIONAL, specification=ISO_19115) public Integer getFeatureInstanceCount()Returns the number of occurrence of feature instances for this feature types, ornullif none.- Returns:
- the number of occurrence of feature instances for this feature types, or
nullif none.
-
setFeatureInstanceCount
Sets a new number of occurrence of feature instances for this feature types.- Parameters:
newValue- the new number of occurrence.- Throws:
IllegalArgumentException- if the given value is zero or negative.
-