public class AbstractIdentifiedType extends Object implements Deprecable, Serializable
IdentifiedType
interface in a future version.
When such interface will be available, most references to AbstractIdentifiedType
in the API
will be replaced by references to the IdentifiedType
interface.Defined in the sis-feature
module
Modifier and Type | Field and Description |
---|---|
static String |
DEFINITION_KEY
Key for the
"definition" property to be given to the constructor. |
static String |
DEPRECATED_KEY
Key for the
"deprecated" property to be given to the constructor. |
static String |
DESCRIPTION_KEY
Key for the
"description" property to be given to the constructor. |
static String |
DESIGNATION_KEY
Key for the
"designation" property to be given to the constructor. |
static String |
NAME_KEY
Key for the
"name" property to be given to the constructor. |
Modifier | Constructor and Description |
---|---|
protected |
AbstractIdentifiedType(Map<String,?> identification)
Constructs a type from the given properties.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Compares this type with the given object for equality.
|
InternationalString |
getDefinition()
Returns a concise definition of the element.
|
InternationalString |
getDescription()
Returns optional information beyond that required for concise definition of the element.
|
InternationalString |
getDesignation()
Returns a natural language designator for the element.
|
GenericName |
getName()
Returns the name of this type.
|
InternationalString |
getRemarks()
Returns comments on or information about this type.
|
int |
hashCode()
Returns a hash code value for this type.
|
boolean |
isDeprecated()
Returns
true if this type is deprecated. |
public static final String NAME_KEY
"name"
property to be given to the constructor.
This is used for setting the value to be returned by getName()
.getName()
,
Constant Field Valuespublic static final String DEFINITION_KEY
"definition"
property to be given to the constructor.
This is used for setting the value to be returned by getDefinition()
.getDefinition()
,
Constant Field Valuespublic static final String DESIGNATION_KEY
"designation"
property to be given to the constructor.
This is used for setting the value to be returned by getDesignation()
.getDesignation()
,
Constant Field Valuespublic static final String DESCRIPTION_KEY
"description"
property to be given to the constructor.
This is used for setting the value to be returned by getDescription()
.getDescription()
,
Constant Field Valuespublic static final String DEPRECATED_KEY
"deprecated"
property to be given to the constructor.
This is used for setting the value to be returned by isDeprecated()
.
If this property is set to true
, then the value associated to DESCRIPTION_KEY
should give the replacement (e.g. "superceded by …").
isDeprecated()
,
Constant Field Valuesprotected AbstractIdentifiedType(Map<String,?> identification) throws IllegalArgumentException
Map key | Value type | Returned by |
---|---|---|
"name" | GenericName or String |
getName() |
"definition" | InternationalString or String |
getDefinition() |
"designation" | InternationalString or String |
getDesignation() |
"description" | InternationalString or String |
getDescription() |
"deprecated" | Boolean |
isDeprecated() |
"locale" | Locale |
(none) |
"definition"
may have a language and country code suffix.
For example the "definition_fr"
property stands for remarks in French and
the "definition_fr_CA"
property stands for remarks in French Canadian.
They are convenience properties for building the InternationalString
value.
The "locale"
property applies only in case of exception for formatting the error message, and
is used only on a best effort basis. The locale is discarded after successful construction
since localizations are applied by the InternationalString.toString(Locale)
method.
identification
- the name and other information to be given to this identified type.IllegalArgumentException
- if a property has an invalid value.public final GenericName getName()
For feature types, the name is mandatory and shall be unique
in the unit processing the data (e.g. a DataStore
reading a file).
IdentifiedType
instances
and need some guarantees about its stability.
public InternationalString getDefinition()
public InternationalString getDesignation()
null
if none.public InternationalString getDescription()
If this type is deprecated, then the description should give indication about the replacement (e.g. "superceded by …").
null
if none.public InternationalString getRemarks()
null
since remarks are not part of the ISO 19109 feature model.getRemarks
in interface Deprecable
null
if none.public boolean isDeprecated()
true
if this type is deprecated.
If this method returns true
, then the remarks should give
indication about the replacement (e.g. "superceded by …").isDeprecated
in interface Deprecable
public int hashCode()
Copyright © 2010–2017 The Apache Software Foundation. All rights reserved.