Package de.uplanet.lucy.server.dataobjects.impl

Class FileValueHolder

java.lang.Object
de.uplanet.lucy.server.dataobjects.impl.FileValueHolder
All Implemented Interfaces:
IFileValueHolder, IObjectValueHolder, IValueHolder<de.uplanet.lucy.server.util.IVHFileDescriptors>
public final class FileValueHolder extends Object implements IFileValueHolder
Holds information about a file. Depending on the value of WebOnly, not all information is available (true -> only path available).

  • Constructor Details

    • FileValueHolder

      public FileValueHolder()
      Standard constructor.

    • FileValueHolder

      public FileValueHolder(IVHFileDescriptor p_descriptor)
      Standard constructor.

    • FileValueHolder

      public FileValueHolder(Collection<? extends IVHFileDescriptor> p_descriptors)
      Parameters:
      p_descriptors - A collections of file descriptors.

    • FileValueHolder

      public FileValueHolder(de.uplanet.lucy.server.util.IVHFileDescriptors p_descriptors)
      Parameters:
      p_descriptors - A file descriptor.

  • Method Details

    • getRawValue

      public de.uplanet.lucy.server.util.IVHFileDescriptors getRawValue()
      Description copied from interface: IFileValueHolder
      Returns a IVHFIleDescriptor instance. Maybe a empty list, never null.
      Specified by:
      getRawValue in interface IFileValueHolder
      Specified by:
      getRawValue in interface IValueHolder<de.uplanet.lucy.server.util.IVHFileDescriptors>
      Returns:
      The raw data.

    • getType

      public QName getType()
      Description copied from interface: IValueHolder
      The type of data this value holder holds.
      Specified by:
      getType in interface IValueHolder<de.uplanet.lucy.server.util.IVHFileDescriptors>

    • getValue

      public de.uplanet.lucy.server.util.IVHFileDescriptors getValue()
      Description copied from interface: IValueHolder
      Get the data that this value holder holds.

      Implementations MUST ensure that multiple calls to this method will return values that equal each other.

      Specified by:
      getValue in interface IValueHolder<de.uplanet.lucy.server.util.IVHFileDescriptors>
      Returns:
      The data.

    • hasValue

      public boolean hasValue()
      Description copied from interface: IValueHolder
      Check if this value holder currently holds data or not.
      Specified by:
      hasValue in interface IValueHolder<de.uplanet.lucy.server.util.IVHFileDescriptors>
      Returns:
      true if the data holder holds data, or false otherwise.

    • getCanonicalLexicalRepresentation

      public String getCanonicalLexicalRepresentation()
      Description copied from interface: IValueHolder
      Get the canonical lexical representation of this value according to it's datatype.
      Specified by:
      getCanonicalLexicalRepresentation in interface IValueHolder<de.uplanet.lucy.server.util.IVHFileDescriptors>
      Returns:
      The canonical lexical representation, or null if such a representation does not exist (e.g. if IValueHolder.hasValue() returns false).

    • isSingleFile

      public boolean isSingleFile()
      Specified by:
      isSingleFile in interface IFileValueHolder
      Returns:
      Returns true if only one file holds the value holder otherwise false.

    • getFirstFile

      public IVHFileDescriptor getFirstFile()
      Specified by:
      getFirstFile in interface IFileValueHolder
      Returns:
      Returns the first file descriptor.

    • getFileName

      @Deprecated public String getFileName()
      Deprecated.
      Intrexx 7: Method will be removed in next major version. Please use getFirstFile().getFileName() instead
      Returns:
      Returns the filename of the document e.g. text_aaa.txt

    • getPath

      @Deprecated public String getPath()
      Deprecated.
      Intrexx 7: Method will be removed in next major version.Please use getFirstFile().getPath() instead
      Returns:
      The path to the file e.g. internal/files/CF56A0484DA23407F958080FDD64F75C63DABC54/textaaa_0.txt

    • getContentType

      @Deprecated public String getContentType()
      Deprecated.
      Intrexx 7: Method will be removed in next major version.Please use getFirstFile().getContentType() instead
      Returns:
      The MIME content type or null.