Class NilReferencingObject
java.lang.Object
org.apache.sis.internal.referencing.NilReferencingObject
- All Implemented Interfaces:
NilObject
,org.opengis.referencing.IdentifiedObject
,org.opengis.referencing.ReferenceSystem
public final class NilReferencingObject
extends Object
implements NilObject, org.opengis.referencing.ReferenceSystem
A referencing object for which every methods return
null
or a neutral value.
This is not a valid object. It is used only for initialization of
objects to be used by JAXB at unmarshalling time, as a way to simulate "no-argument"
constructor required by JAXB.- Since:
- 0.4
- Version:
- 0.6
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final NilReferencingObject
The unique instance.static final org.opengis.referencing.ReferenceIdentifier
The default name ofNilReferencingObject
instances.Fields inherited from interface org.opengis.referencing.IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
Fields inherited from interface org.opengis.referencing.ReferenceSystem
DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCollection
<org.opengis.util.GenericName> getAlias()
org.opengis.metadata.extent.Extent
Set
<org.opengis.referencing.ReferenceIdentifier> org.opengis.referencing.ReferenceIdentifier
getName()
This object is empty because the value will be provided later.org.opengis.util.InternationalString
org.opengis.util.InternationalString
getScope()
toWKT()
Throws the exception in all cases.
-
Field Details
-
UNNAMED
public static final org.opengis.referencing.ReferenceIdentifier UNNAMEDThe default name ofNilReferencingObject
instances. We use this value becauseIdentifiedObject.getName()
is a mandatory property and not all code is tolerant to null name.Note: in theory we do not need a default name because it will be replaced by the value of the<gml:name>
element anyway at XML unmarshalling time. But not all XML documents are valid, so the<gml:name>
may be missing.- Since:
- 0.6
-
INSTANCE
The unique instance.
-
-
Constructor Details
-
NilReferencingObject
private NilReferencingObject()Do not allow other instantiation ofINSTANCE
.
-
-
Method Details
-
getNilReason
This object is empty because the value will be provided later.- Specified by:
getNilReason
in interfaceNilObject
- Returns:
- the reason why this object contains no information.
- See Also:
-
getName
public org.opengis.referencing.ReferenceIdentifier getName()- Specified by:
getName
in interfaceorg.opengis.referencing.IdentifiedObject
-
getAlias
- Specified by:
getAlias
in interfaceorg.opengis.referencing.IdentifiedObject
-
getIdentifiers
- Specified by:
getIdentifiers
in interfaceorg.opengis.referencing.IdentifiedObject
-
getRemarks
public org.opengis.util.InternationalString getRemarks()- Specified by:
getRemarks
in interfaceorg.opengis.referencing.IdentifiedObject
-
getScope
public org.opengis.util.InternationalString getScope()- Specified by:
getScope
in interfaceorg.opengis.referencing.ReferenceSystem
-
getDomainOfValidity
public org.opengis.metadata.extent.Extent getDomainOfValidity()- Specified by:
getDomainOfValidity
in interfaceorg.opengis.referencing.ReferenceSystem
-
toWKT
Throws the exception in all cases.- Specified by:
toWKT
in interfaceorg.opengis.referencing.IdentifiedObject
- Returns:
- never return.
- Throws:
UnformattableObjectException
- always thrown.
-