Class DefaultSeries
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.citation.DefaultSeries
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.citation.Series
Information about the series, or aggregate dataset, to which a dataset belongs.
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.3
- 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 String
Information identifying the issue of the series.private org.opengis.util.InternationalString
Name of the series, or aggregate dataset, of which the dataset is a part.private String
Details on which pages of the publication the article was published.private static final long
Serial number for inter-operability with different versions.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a default series.DefaultSeries
(CharSequence name) Constructs a series with the specified name.DefaultSeries
(org.opengis.metadata.citation.Series object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultSeries
castOrCopy
(org.opengis.metadata.citation.Series object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns information identifying the issue of the series.org.opengis.util.InternationalString
getName()
Returns the name of the series, or aggregate dataset, of which the dataset is a part.getPage()
Returns details on which pages of the publication the article was published.void
setIssueIdentification
(String newValue) Sets information identifying the issue of the series.void
setName
(org.opengis.util.InternationalString newValue) Sets the name of the series, or aggregate dataset, of which the dataset is a part.void
Sets details on which pages of the publication the article was published.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods 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 inter-operability with different versions.- See Also:
-
name
private org.opengis.util.InternationalString nameName of the series, or aggregate dataset, of which the dataset is a part. -
issueIdentification
Information identifying the issue of the series. -
page
Details on which pages of the publication the article was published.
-
-
Constructor Details
-
DefaultSeries
public DefaultSeries()Constructs a default series. -
DefaultSeries
Constructs a series with the specified name.- Parameters:
name
- the name of the series of which the dataset is a part, ornull
.
-
DefaultSeries
public DefaultSeries(org.opengis.metadata.citation.Series 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.- Parameters:
object
- the metadata to copy values from, ornull
if none.- See Also:
-
-
Method Details
-
castOrCopy
Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:- If the given object is
null
, then this method returnsnull
. - Otherwise if the given object is already an instance of
DefaultSeries
, then it is returned unchanged. - Otherwise a new
DefaultSeries
instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
- Parameters:
object
- the object to get as a SIS implementation, ornull
if none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
null
if the argument was null.
- If the given object is
-
getName
public org.opengis.util.InternationalString getName()Returns the name of the series, or aggregate dataset, of which the dataset is a part.- Specified by:
getName
in interfaceorg.opengis.metadata.citation.Series
- Returns:
- the name of the series or aggregate dataset, or
null
.
-
setName
public void setName(org.opengis.util.InternationalString newValue) Sets the name of the series, or aggregate dataset, of which the dataset is a part.- Parameters:
newValue
- the new name, ornull
if none.
-
getIssueIdentification
Returns information identifying the issue of the series.Upcoming API change — generalization
As of ISO 19115:2014,String
is replaced by theInternationalString
interface. This change will be tentatively applied in GeoAPI 4.0.- Specified by:
getIssueIdentification
in interfaceorg.opengis.metadata.citation.Series
- Returns:
- information identifying the issue of the series, or
null
.
-
setIssueIdentification
Sets information identifying the issue of the series.Upcoming API change — generalization
As of ISO 19115:2014,String
is replaced by theInternationalString
interface. This change will be tentatively applied in GeoAPI 4.0.- Parameters:
newValue
- the new issue identification, ornull
if none.
-
getPage
Returns details on which pages of the publication the article was published.Upcoming API change — generalization
As of ISO 19115:2014,String
is replaced by theInternationalString
interface. This change will be tentatively applied in GeoAPI 4.0.- Specified by:
getPage
in interfaceorg.opengis.metadata.citation.Series
- Returns:
- details on which pages of the publication the article was published, or
null
.
-
setPage
Sets details on which pages of the publication the article was published.Upcoming API change — generalization
As of ISO 19115:2014,String
is replaced by theInternationalString
interface. This change will be tentatively applied in GeoAPI 4.0.- Parameters:
newValue
- the new page, ornull
if none.
-