Interface File

All Superinterfaces:
Serializable
All Known Implementing Classes:
FileImpl

public interface File extends Serializable

Interface for the manifest-file XML type

Interface for the manifest-file XML type used in the Manifest document type.
A file describes a single resource (e.g. other XML document, preview file etc.) in a meta data archive.

The default implementation (JAXB compliant class) is FileImpl.

  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the mime type of this file.
    Gets the name of this file.
    double
    Gets the resolution of this file.
    void
    setMimetype(String mimetype)
    Sets the mime type of this file.
    void
    Sets the name of this file.
    void
    setResolution(double resolution)
    Sets the resolution of this file.
  • Method Details

    • getName

      String getName()

      Gets the name of this file.

      Gets the name of this file. The name is the relative path of the file within the meta data archive.

      Returns:
      name of the file
    • setName

      void setName(String name)

      Sets the name of this file.

      Sets the name of this file. The name must be the relative path of the file within the meta data archive.

      Parameters:
      name - the new name
    • getMimetype

      String getMimetype()

      Gets the mime type of this file.

      Gets the mime type of this file in the common format media-type/subtype-identifier, e.g. image/jpeg or application/xml.

      Returns:
      mime type of this file
    • setMimetype

      void setMimetype(String mimetype)

      Sets the mime type of this file.

      Sets the mime type of this file. The type must be provided in the common format media-type/subtype-identifier, e.g. image/jpeg or application/xml.

      Parameters:
      mimetype - mime type for this file
    • getResolution

      double getResolution()

      Gets the resolution of this file.

      Gets the resolution of this file in dpi. If the file has no resolution (e.g. XML files), this attribute may be omitted or just be set to 0.0

      Returns:
      resolution of this file in dpi
    • setResolution

      void setResolution(double resolution)

      Sets the resolution of this file.

      Sets the resolution of this file in dpi. If the file has no resolution (e.g. XML files), this attribute may be omitted or just be set to 0.0

      Parameters:
      resolution - resolution for this file in dpi