org.geotoolkit.metadata.iso.identification
Class DefaultBrowseGraphic

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultBrowseGraphic

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, BrowseGraphic

@ThreadSafe
public class DefaultBrowseGraphic
extends MetadataEntity
implements BrowseGraphic

Graphic that provides an illustration of the dataset (should include a legend for the graphic).

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultBrowseGraphic()
Constructs an initially empty browse graphic.

DefaultBrowseGraphic(BrowseGraphic source)
Constructs a metadata entity initialized with the values from the specified metadata.

DefaultBrowseGraphic(URI fileName)
Creates a browse graphics initialized to the specified URI.

Method Summary

static DefaultBrowseGraphic	castOrCopy(BrowseGraphic object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
InternationalString	getFileDescription() Returns the text description of the illustration.
URI	getFileName() Returns the name of the file that contains a graphic that provides an illustration of the dataset.
String	getFileType() Format in which the illustration is encoded.
void	setFileDescription(InternationalString newValue) Sets the text description of the illustration.
void	setFileName(URI newValue) Sets the name of the file that contains a graphic that provides an illustration of the dataset.
void	setFileType(String newValue) Sets the format in which the illustration is encoded.

Methods inherited from class MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultBrowseGraphic

public DefaultBrowseGraphic()

Constructs an initially empty browse graphic.

DefaultBrowseGraphic

public DefaultBrowseGraphic(BrowseGraphic source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Since:

2.4

DefaultBrowseGraphic

public DefaultBrowseGraphic(URI fileName)

Creates a browse graphics initialized to the specified URI.

Parameters:

fileName - The name of the file that contains a graphic.

Method Detail

castOrCopy

public static DefaultBrowseGraphic castOrCopy(BrowseGraphic object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getFileName

public URI getFileName()

Returns the name of the file that contains a graphic that provides an illustration of the dataset.

Specified by:

getFileName in interface BrowseGraphic

setFileName

public void setFileName(URI newValue)

Sets the name of the file that contains a graphic that provides an illustration of the dataset.

Parameters:

newValue - The new filename.

getFileDescription

public InternationalString getFileDescription()

Returns the text description of the illustration.

Specified by:

getFileDescription in interface BrowseGraphic

setFileDescription

public void setFileDescription(InternationalString newValue)

Sets the text description of the illustration.

Parameters:

newValue - The new file description.

getFileType

public String getFileType()

Format in which the illustration is encoded. Examples: CGM, EPS, GIF, JPEG, PBM, PS, TIFF, XWD.

Specified by:

getFileType in interface BrowseGraphic

setFileType

public void setFileType(String newValue)

Sets the format in which the illustration is encoded.

Parameters:

newValue - The new fime type.