Class DefaultBrowseGraphic

  • All Implemented Interfaces:
    Serializable, Emptiable, Lenient­Comparable, Identified­Object, Browse­Graphic

    public class DefaultBrowseGraphic
    extends ISOMetadata
    implements 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_Browse­Graphic   └─file­Name………… 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
    See Also:
    Serialized Form

    Defined in the sis-metadata module

    • Constructor Detail

      • DefaultBrowseGraphic

        public DefaultBrowseGraphic()
        Constructs an initially empty browse graphic.
      • DefaultBrowseGraphic

        public DefaultBrowseGraphic​(URI fileName)
        Creates a browse graphics initialized to the specified URI.
        Parameters:
        file­Name - the name of the file that contains a graphic.
      • DefaultBrowseGraphic

        public DefaultBrowseGraphic​(BrowseGraphic 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(Browse­Graphic)
    • Method Detail

      • castOrCopy

        public static DefaultBrowseGraphic castOrCopy​(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 returns null.
        • Otherwise if the given object is already an instance of Default­Browse­Graphic, then it is returned unchanged.
        • Otherwise a new Default­Browse­Graphic 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.
      • getFileName

        public URI getFileName()
        Returns the name of the file that contains a graphic that provides an illustration of the dataset.
        Specified by:
        get­File­Name in interface Browse­Graphic
        Returns:
        file that contains a graphic that provides an illustration of the dataset, or null.
      • setFileName

        public void setFileName​(URI newValue)
        Sets the name of the file that contains a graphic that provides an illustration of the dataset.
        Parameters:
        new­Value - the new filename.
      • setFileDescription

        public void setFileDescription​(InternationalString newValue)
        Sets the text description of the illustration.
        Parameters:
        new­Value - the new file description.
      • getFileType

        public String getFileType()
        Format in which the illustration is encoded.
        Example: CGM, EPS, GIF, JPEG, PBM, PS, TIFF, XWD.
        Specified by:
        get­File­Type in interface Browse­Graphic
        Returns:
        format in which the illustration is encoded, or null.
      • setFileType

        public void setFileType​(String newValue)
        Sets the format in which the illustration is encoded. Raster formats are encouraged to use one of the names returned by Image­IO​.get­Reader­Format­Names().
        Parameters:
        new­Value - the new file type.
      • setImageConstraints

        public void setImageConstraints​(Collection<? extends Constraints> newValues)
        Sets the restrictions on access and / or use of browse graphic.
        Parameters:
        new­Values - the new restrictions on access and / or use of browse graphic.
        Since:
        0.5
      • setLinkages

        public void setLinkages​(Collection<? extends OnlineResource> newValues)
        Sets the links to browse graphic.
        Parameters:
        new­Values - the new links to browse graphic.
        Since:
        0.5