Class DefaultBrowseGraphic
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.identification.DefaultBrowseGraphic
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.identification.BrowseGraphic
public class DefaultBrowseGraphic
extends ISOMetadata
implements org.opengis.metadata.identification.BrowseGraphic
Graphic that provides an illustration of the dataset (should include a legend for the graphic).
The following property is mandatory in a well-formed metadata according ISO 19115:
MD_BrowseGraphic
└─fileName…………
Name of the file that contains a graphic that provides an illustration of the dataset.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
Text description of the illustration.private URI
Name of the file that contains a graphic that provides an illustration of the dataset.private String
Format in which the illustration is encoded.private Collection<org.opengis.metadata.constraint.Constraints>
Restrictions on access and/or of browse graphic.private Collection<org.opengis.metadata.citation.OnlineResource>
Links to browse graphic.private static final long
Serial number for compatibility with different versions.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty browse graphic.DefaultBrowseGraphic
(URI fileName) Creates a browse graphics initialized to the specified URI.DefaultBrowseGraphic
(org.opengis.metadata.identification.BrowseGraphic object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultBrowseGraphic
castOrCopy
(org.opengis.metadata.identification.BrowseGraphic object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.util.InternationalString
Returns the text description of the illustration.Returns the name of the file that contains a graphic that provides an illustration of the dataset.Format in which the illustration is encoded.private Collection<org.opengis.metadata.constraint.Constraints>
Invoked by JAXB at both marshalling and unmarshalling time.Collection<org.opengis.metadata.constraint.Constraints>
Returns the restrictions on access and / or use of browse graphic.private Collection<org.opengis.metadata.citation.OnlineResource>
Collection<org.opengis.metadata.citation.OnlineResource>
Return the links to browse graphic.void
setFileDescription
(org.opengis.util.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.void
setImageConstraints
(Collection<? extends org.opengis.metadata.constraint.Constraints> newValues) Sets the restrictions on access and / or use of browse graphic.void
setLinkages
(Collection<? extends org.opengis.metadata.citation.OnlineResource> newValues) Sets the links to browse graphic.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 compatibility with different versions.- See Also:
-
fileName
Name of the file that contains a graphic that provides an illustration of the dataset. -
fileDescription
private org.opengis.util.InternationalString fileDescriptionText description of the illustration. -
fileType
Format in which the illustration is encoded. Examples: CGM, EPS, GIF, JPEG, PBM, PS, TIFF, XWD. -
imageConstraints
Restrictions on access and/or of browse graphic. -
linkages
Links to browse graphic.
-
-
Constructor Details
-
DefaultBrowseGraphic
public DefaultBrowseGraphic()Constructs an initially empty browse graphic. -
DefaultBrowseGraphic
Creates a browse graphics initialized to the specified URI.- Parameters:
fileName
- the name of the file that contains a graphic.
-
DefaultBrowseGraphic
public DefaultBrowseGraphic(org.opengis.metadata.identification.BrowseGraphic 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 DefaultBrowseGraphic castOrCopy(org.opengis.metadata.identification.BrowseGraphic 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
DefaultBrowseGraphic
, then it is returned unchanged. - Otherwise a new
DefaultBrowseGraphic
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
-
getFileName
Returns the name of the file that contains a graphic that provides an illustration of the dataset.- Specified by:
getFileName
in interfaceorg.opengis.metadata.identification.BrowseGraphic
- Returns:
- file that contains a graphic that provides an illustration of the dataset, or
null
.
-
setFileName
Sets the name of the file that contains a graphic that provides an illustration of the dataset.- Parameters:
newValue
- the new filename.
-
getFileDescription
public org.opengis.util.InternationalString getFileDescription()Returns the text description of the illustration.- Specified by:
getFileDescription
in interfaceorg.opengis.metadata.identification.BrowseGraphic
- Returns:
- text description of the illustration, or
null
.
-
setFileDescription
public void setFileDescription(org.opengis.util.InternationalString newValue) Sets the text description of the illustration.- Parameters:
newValue
- the new file description.
-
getFileType
Format in which the illustration is encoded.Example: CGM, EPS, GIF, JPEG, PBM, PS, TIFF, XWD.- Specified by:
getFileType
in interfaceorg.opengis.metadata.identification.BrowseGraphic
- Returns:
- format in which the illustration is encoded, or
null
.
-
setFileType
Sets the format in which the illustration is encoded. Raster formats are encouraged to use one of the names returned byImageIO.getReaderFormatNames()
.- Parameters:
newValue
- the new file type.
-
getImageConstraints
@UML(identifier="imageContraints", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.constraint.Constraints> getImageConstraints()Returns the restrictions on access and / or use of browse graphic.- Returns:
- restrictions on access and / or use of browse graphic.
- Since:
- 0.5
-
setImageConstraints
public void setImageConstraints(Collection<? extends org.opengis.metadata.constraint.Constraints> newValues) Sets the restrictions on access and / or use of browse graphic.- Parameters:
newValues
- the new restrictions on access and / or use of browse graphic.- Since:
- 0.5
-
getLinkages
@UML(identifier="linkage", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.citation.OnlineResource> getLinkages()Return the links to browse graphic.- Returns:
- the links to browse graphic.
- Since:
- 0.5
-
setLinkages
public void setLinkages(Collection<? extends org.opengis.metadata.citation.OnlineResource> newValues) Sets the links to browse graphic.- Parameters:
newValues
- the new links to browse graphic.- Since:
- 0.5
-
getImageConstraint
Invoked by JAXB at both marshalling and unmarshalling time. This attribute has been added by ISO 19115:2014 standard. If (and only if) marshalling an older standard version, we omit this attribute. -
getLinkage
-