org.apache.sis.metadata.iso.lineage

Class DefaultProcessStepReport

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultProcessStepReport

All Implemented Interfaces:

Serializable, Cloneable, Emptiable, LenientComparable, IdentifiedObject, ProcessStepReport

@TitleProperty(name="name")
public class DefaultProcessStepReport
extends ISOMetadata
implements ProcessStepReport

Report of what occurred during the process step. The following property is mandatory in a well-formed metadata according ISO 19115:

LE_Process­Step­Report └─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

See Also:

Serialized Form

Defined in the sis-metadata module

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor and Description
DefaultProcessStepReport() Constructs an initially empty process step report.
DefaultProcessStepReport(ProcessStepReport object) Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method and Description
static DefaultProcessStepReport	castOrCopy(ProcessStepReport object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.
InternationalString	getDescription() Returns the textual description of what occurred during the process step.
InternationalString	getFileType() Returns the type of file that contains the processing report.
InternationalString	getName() Returns the name of the processing report.
void	setDescription(InternationalString newValue) Sets the textual description of what occurred during the process step.
void	setFileType(InternationalString newValue) Sets the type of file that contains the processing report.
void	setName(InternationalString newValue) Sets the name of the processing report.

Methods inherited from class ISOMetadata

freeze, get­Identifier­Map, get­Identifiers, get­Standard

Methods inherited from class ModifiableMetadata

check­Write­Permission, clone, collection­Type, copy­Collection, copy­List, copy­Set, is­Modifiable, non­Null­Collection, non­Null­List, non­Null­Set, singleton, unmodifiable, write­Collection, write­List, 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

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

Constructor Detail

DefaultProcessStepReport

public DefaultProcessStepReport()

Constructs an initially empty process step report.

DefaultProcessStepReport

public DefaultProcessStepReport(ProcessStepReport object)

Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since the other metadata contained in the given object are not recursively copied.

Parameters:

object - the metadata to copy values from, or null if none.

See Also:

cast­Or­Copy(Process­Step­Report)

Method Detail

castOrCopy

public static DefaultProcessStepReport castOrCopy(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 returns null.
• Otherwise if the given object is already an instance of Default­Process­Step­Report, then it is returned unchanged.
• Otherwise a new Default­Process­Step­Report instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since the other metadata contained in the given object are not recursively copied.

Parameters:

object - the object to get as a SIS implementation, or null 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.

getName

public InternationalString getName()

Returns the name of the processing report.

Specified by:

get­Name in interface Process­Step­Report

Returns:

name of the processing report, or null.

setName

public void setName(InternationalString newValue)

Sets the name of the processing report.

Parameters:

new­Value - the new name value.

getDescription

public InternationalString getDescription()

Returns the textual description of what occurred during the process step.

Specified by:

get­Description in interface Process­Step­Report

Returns:

what occurred during the process step, or null.

setDescription

public void setDescription(InternationalString newValue)

Sets the textual description of what occurred during the process step.

Parameters:

new­Value - the new description value.

getFileType

public InternationalString getFileType()

Returns the type of file that contains the processing report.

Specified by:

get­File­Type in interface Process­Step­Report

Returns:

type of file that contains the processing report, or null.

setFileType

public void setFileType(InternationalString newValue)

Sets the type of file that contains the processing report.

Parameters:

new­Value - the new file type value.