Class DefaultDataFile

  • All Implemented Interfaces:
    Serializable, Emptiable, Lenient­Comparable, Identified­Object, Data­File

    public class DefaultDataFile
    extends ISOMetadata
    implements DataFile
    Description of a transfer data file. The following properties are mandatory in a well-formed metadata according ISO 19115:
    MX_Data­File   ├─file­Name…………………………………………………………… Name or path of the file.   ├─file­Description………………………………………… Text description of the data.   └─file­Type…………………………………………………………… Format in which the data is encoded.

    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

      • DefaultDataFile

        public DefaultDataFile()
        Constructs an initially empty data file.
      • DefaultDataFile

        public DefaultDataFile​(DataFile 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(Data­File)
    • Method Detail

      • castOrCopy

        public static DefaultDataFile castOrCopy​(DataFile 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­Data­File, then it is returned unchanged.
        • Otherwise a new Default­Data­File 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.
      • setFileName

        public void setFileName​(URI newValue)
        Sets the name or path of the file.
        Parameters:
        new­Value - the new filename or path.
        Since:
        1.0
      • setFileDescription

        public void setFileDescription​(InternationalString newValue)
        Sets the text description of the file.
        Parameters:
        new­Value - the new file description.
        Since:
        1.0
      • 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.
      • getFeatureTypes

        public Collection<LocalName> getFeatureTypes()
        Returns the list of feature types concerned by the transfer data file. Depending on the transfer choices, a data file may contain data related to one or many feature types. This attribute may be omitted when the dataset is composed of a single file and/or the data does not relate to a feature catalogue.
        Specified by:
        get­Feature­Types in interface Data­File
        Returns:
        list of features types concerned by the transfer data file.
      • setFeatureTypes

        public void setFeatureTypes​(Collection<? extends LocalName> newValues)
        Sets the list of feature types concerned by the transfer data file.
        Parameters:
        new­Values - the new feature type values.
      • getFileFormat

        @Deprecated
        public Format getFileFormat()
        Deprecated.
        Removed in latest XSD schemas.
        Returns the format of the transfer data file.
        Specified by:
        get­File­Format in interface Data­File
        Returns:
        format of the transfer data file, or null.
      • setFileFormat

        @Deprecated
        public void setFileFormat​(Format newValue)
        Deprecated.
        Removed in latest XSD schemas.
        Sets the format of the transfer data file.
        Parameters:
        new­Value - the new file format value.