Class DefaultProcessStepReport
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.lineage.DefaultProcessStepReport
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.lineage.ProcessStepReport
@TitleProperty(name="name")
public class DefaultProcessStepReport
extends ISOMetadata
implements org.opengis.metadata.lineage.ProcessStepReport
Report of what occurred during the process step.
The following property is mandatory in a well-formed metadata according ISO 19115:
LE_ProcessStepReport
└─name………………………………
Name of the processing report.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 org.opengis.util.InternationalString
Textual description of what occurred during the process step.private org.opengis.util.InternationalString
Type of file that contains the processing report.private org.opengis.util.InternationalString
Name of the processing report.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 an initially empty process step report.DefaultProcessStepReport
(org.opengis.metadata.lineage.ProcessStepReport object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultProcessStepReport
castOrCopy
(org.opengis.metadata.lineage.ProcessStepReport object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.util.InternationalString
Returns the textual description of what occurred during the process step.org.opengis.util.InternationalString
Returns the type of file that contains the processing report.org.opengis.util.InternationalString
getName()
Returns the name of the processing report.void
setDescription
(org.opengis.util.InternationalString newValue) Sets the textual description of what occurred during the process step.void
setFileType
(org.opengis.util.InternationalString newValue) Sets the type of file that contains the processing report.void
setName
(org.opengis.util.InternationalString newValue) Sets the name of the processing report.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 processing report. -
description
private org.opengis.util.InternationalString descriptionTextual description of what occurred during the process step. -
fileType
private org.opengis.util.InternationalString fileTypeType of file that contains the processing report.
-
-
Constructor Details
-
DefaultProcessStepReport
public DefaultProcessStepReport()Constructs an initially empty process step report. -
DefaultProcessStepReport
public DefaultProcessStepReport(org.opengis.metadata.lineage.ProcessStepReport 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
public static DefaultProcessStepReport castOrCopy(org.opengis.metadata.lineage.ProcessStepReport object) 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
DefaultProcessStepReport
, then it is returned unchanged. - Otherwise a new
DefaultProcessStepReport
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 processing report.- Specified by:
getName
in interfaceorg.opengis.metadata.lineage.ProcessStepReport
- Returns:
- name of the processing report, or
null
.
-
setName
public void setName(org.opengis.util.InternationalString newValue) Sets the name of the processing report.- Parameters:
newValue
- the new name value.
-
getDescription
public org.opengis.util.InternationalString getDescription()Returns the textual description of what occurred during the process step.- Specified by:
getDescription
in interfaceorg.opengis.metadata.lineage.ProcessStepReport
- Returns:
- what occurred during the process step, or
null
.
-
setDescription
public void setDescription(org.opengis.util.InternationalString newValue) Sets the textual description of what occurred during the process step.- Parameters:
newValue
- the new description value.
-
getFileType
public org.opengis.util.InternationalString getFileType()Returns the type of file that contains the processing report.- Specified by:
getFileType
in interfaceorg.opengis.metadata.lineage.ProcessStepReport
- Returns:
- type of file that contains the processing report, or
null
.
-
setFileType
public void setFileType(org.opengis.util.InternationalString newValue) Sets the type of file that contains the processing report.- Parameters:
newValue
- the new file type value.
-