Class DefaultDataFile
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultDataFile
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- DataFile
Description of a transfer data file.
 The following properties are mandatory in a well-formed metadata according ISO 19115:
 
 
MX_DataFile
   ├─fileName…………………………………………………………… Name or path of the file.
   ├─fileDescription………………………………………… Text description of the data.
   └─fileType…………………………………………………………… 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 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 data file.DefaultDataFile(DataFile object) Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultDataFilecastOrCopy(DataFile object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the list of feature types concerned by the transfer data file.Returns the text description of the file.Deprecated.Removed in latest XSD schemas.Returns the name or path of the file.Format in which the file is encoded.voidsetFeatureTypes(Collection<? extends LocalName> newValues) Sets the list of feature types concerned by the transfer data file.voidsetFileDescription(InternationalString newValue) Sets the text description of the file.voidsetFileFormat(Format newValue) Deprecated.Removed in latest XSD schemas.voidsetFileName(URI newValue) Sets the name or path of the file.voidsetFileType(String newValue) Sets the format in which the illustration is encoded.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- 
DefaultDataFilepublic DefaultDataFile()Constructs an initially empty data file.
- 
DefaultDataFileConstructs 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
       DefaultDataFile, then it is returned unchanged.
- Otherwise a new DefaultDataFileinstance 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 or path of the file.- Returns:
- file name, or null.
- Since:
- 1.0
- See Also:
 
- 
setFileNameSets the name or path of the file.- Parameters:
- newValue- the new filename or path.
- Since:
- 1.0
 
- 
getFileDescriptionReturns the text description of the file.- Returns:
- text description of the file, or null.
- Since:
- 1.0
- See Also:
 
- 
setFileDescriptionSets the text description of the file.- Parameters:
- newValue- the new file description.
- Since:
- 1.0
 
- 
getFileTypeFormat in which the file is encoded.- Returns:
- format in which the file is encoded, or null.
- Since:
- 1.0
- See Also:
 
- 
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.
 
- 
getFeatureTypesReturns 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:
- getFeatureTypesin interface- DataFile
- Returns:
- list of features types concerned by the transfer data file.
 
- 
setFeatureTypesSets the list of feature types concerned by the transfer data file.- Parameters:
- newValues- the new feature type values.
 
- 
getFileFormatDeprecated.Removed in latest XSD schemas.Returns the format of the transfer data file.- Specified by:
- getFileFormatin interface- DataFile
- Returns:
- format of the transfer data file, or null.
 
- 
setFileFormatDeprecated.Removed in latest XSD schemas.Sets the format of the transfer data file.- Parameters:
- newValue- the new file format value.
 
 
-