Class DefaultBrowseGraphic
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultBrowseGraphic
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- 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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty browse graphic.DefaultBrowseGraphic(URI fileName) Creates a browse graphics initialized to the specified URI.DefaultBrowseGraphic(BrowseGraphic object) Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultBrowseGraphiccastOrCopy(BrowseGraphic object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.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.Returns the restrictions on access and / or use of browse graphic.Return the links to browse graphic.voidsetFileDescription(InternationalString newValue) Sets the text description of the illustration.voidsetFileName(URI newValue) Sets the name of the file that contains a graphic that provides an illustration of the dataset.voidsetFileType(String newValue) Sets the format in which the illustration is encoded.voidsetImageConstraints(Collection<? extends Constraints> newValues) Sets the restrictions on access and / or use of browse graphic.voidsetLinkages(Collection<? extends OnlineResource> newValues) Sets the links to browse graphic.Methods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultBrowseGraphicpublic DefaultBrowseGraphic()Constructs an initially empty browse graphic.
- 
DefaultBrowseGraphicCreates a browse graphics initialized to the specified URI.- Parameters:
- fileName- the name of the file that contains a graphic.
 
- 
DefaultBrowseGraphicConstructs 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, or- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 DefaultBrowseGraphicinstance 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, or- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getFileNameReturns the name of the file that contains a graphic that provides an illustration of the dataset.- Specified by:
- getFileNamein interface- BrowseGraphic
- Returns:
- file that contains a graphic that provides an illustration of the dataset, or null.
 
- 
setFileNameSets the name of the file that contains a graphic that provides an illustration of the dataset.- Parameters:
- newValue- the new filename.
 
- 
getFileDescriptionReturns the text description of the illustration.- Specified by:
- getFileDescriptionin interface- BrowseGraphic
- Returns:
- text description of the illustration, or null.
 
- 
setFileDescriptionSets the text description of the illustration.- Parameters:
- newValue- the new file description.
 
- 
getFileTypeFormat in which the illustration is encoded.Example: CGM, EPS, GIF, JPEG, PBM, PS, TIFF, XWD.- Specified by:
- getFileTypein interface- BrowseGraphic
- Returns:
- format in which the illustration is encoded, or null.
 
- 
setFileTypeSets 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<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
 
- 
setImageConstraintsSets 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<OnlineResource> getLinkages()Return the links to browse graphic.- Returns:
- the links to browse graphic.
- Since:
- 0.5
 
- 
setLinkagesSets the links to browse graphic.- Parameters:
- newValues- the new links to browse graphic.
- Since:
- 0.5
 
 
-