Module org.apache.sis.metadata

Package org.apache.sis.metadata.iso.content

Class DefaultFeatureTypeInfo

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultFeatureTypeInfo

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object

@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 Feature­Type­Info 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 XML instead.

Since:

0.5

See Also:

• Feature­Naming<E>
• Default­Feature­Type
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor	Description
Default­Feature­Type­Info()	Constructs an initially empty feature type info.
Default­Feature­Type­Info(Default­Feature­Type­Info object)	Constructs a new instance initialized with the values from the specified metadata object.
Default­Feature­Type­Info(Generic­Name feature­Type­Name)	Constructs a feature type info initialized to the specified name.

Method Summary

Modifier and Type	Method	Description
Integer	get­Feature­Instance­Count()	Returns the number of occurrence of feature instances for this feature types, or null if none.
Generic­Name	get­Feature­Type­Name()	Returns the name of the feature type.
void	set­Feature­Instance­Count(Integer new­Value)	Sets a new number of occurrence of feature instances for this feature types.
void	set­Feature­Type­Name(Generic­Name new­Value)	Sets the name of the feature type.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier, transition­To

Methods inherited from class ModifiableMetadata

check­Write­Permission, collection­Type, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, equals, equals, get­Interface, hash­Code, is­Empty, prune, to­String

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultFeatureTypeInfo

public DefaultFeatureTypeInfo()

Constructs an initially empty feature type info.

DefaultFeatureTypeInfo

public DefaultFeatureTypeInfo(GenericName featureTypeName)

Constructs a feature type info initialized to the specified name.

Parameters:

feature­Type­Name - name of the feature type.

DefaultFeatureTypeInfo

public DefaultFeatureTypeInfo(DefaultFeatureTypeInfo object)

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, or null if none.

Method Details

getFeatureTypeName

@UML(identifier="featureTypeName",
     obligation=MANDATORY,
     specification=ISO_19115)
public GenericName getFeatureTypeName()

Returns the name of the feature type.

Returns:

name of the feature type.

See Also:

• Abstract­Identified­Type.get­Name()

setFeatureTypeName

public void setFeatureTypeName(GenericName newValue)

Sets the name of the feature type.

Parameters:

new­Value - 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, or null if none.

Returns:

the number of occurrence of feature instances for this feature types, or null if none.

setFeatureInstanceCount

public void setFeatureInstanceCount(Integer newValue)

Sets a new number of occurrence of feature instances for this feature types.

Parameters:

new­Value - the new number of occurrence.

Throws:

Illegal­Argument­Exception - if the given value is zero or negative.