Class DBFileDocument

    • Field Detail

      • ORIGINAL_FILENAME_FIELD

        public static final java.lang.String ORIGINAL_FILENAME_FIELD
        See Also:
        Constant Field Values
      • CONTENT_TYPE_FIELD

        public static final java.lang.String CONTENT_TYPE_FIELD
        See Also:
        Constant Field Values
      • REMOTE_URI_FIELD

        public static final java.lang.String REMOTE_URI_FIELD
        See Also:
        Constant Field Values
      • UPLOAD_DATE_FIELD

        public static final java.lang.String UPLOAD_DATE_FIELD
        See Also:
        Constant Field Values
      • DESCRIPTION_FIELD

        public static final java.lang.String DESCRIPTION_FIELD
        See Also:
        Constant Field Values
      • HIBERNATE_MAPPING_FILENAME

        public static final int HIBERNATE_MAPPING_FILENAME
        See Also:
        Constant Field Values
      • HIBERNATE_MAPPING_ORIGINALFILENAME

        public static final int HIBERNATE_MAPPING_ORIGINALFILENAME
        See Also:
        Constant Field Values
      • HIBERNATE_MAPPING_CONTENTTYPE

        public static final int HIBERNATE_MAPPING_CONTENTTYPE
        See Also:
        Constant Field Values
      • HIBERNATE_MAPPING_REMOTEURI

        public static final int HIBERNATE_MAPPING_REMOTEURI
        See Also:
        Constant Field Values
      • HIBERNATE_MAPPING_UPLOADDATE

        public static final int HIBERNATE_MAPPING_UPLOADDATE
        See Also:
        Constant Field Values
      • HIBERNATE_MAPPING_PDFUPLOADDATE

        public static final int HIBERNATE_MAPPING_PDFUPLOADDATE
        See Also:
        Constant Field Values
    • Constructor Detail

      • DBFileDocument

        public DBFileDocument()
      • DBFileDocument

        public DBFileDocument​(Publication other)
      • DBFileDocument

        public DBFileDocument​(FileDocument other)
    • Method Detail

      • getDescriptionMLE

        public java.lang.String getDescriptionMLE()
        Returns the encoded descriptionML.
        Returns:
        the encoded descriptionML.
        Since:
        jcms-10.0.0
      • setDescriptionMLE

        public void setDescriptionMLE​(java.lang.String v)
        Set the value for the encoded descriptionML
        Parameters:
        v - the encoded descriptionML
        Since:
        jcms-10.0.0
      • checkCreate

        public ControllerStatus checkCreate​(Member mbr,
                                            java.util.Map context)
        Description copied from class: Publication
        Checks if the creation can be performed
        Overrides:
        checkCreate in class Publication
        Parameters:
        mbr - the member which requests the write operation
        context - a map which contains context parameters (may be null)
        Returns:
        a ControllerStatus
      • performAfterWrite

        protected void performAfterWrite​(int op,
                                         Member mbr,
                                         java.util.Map context)
        Description copied from class: Data
        Called to perform some action after the write.
        Overrides:
        performAfterWrite in class FileDocument
        Parameters:
        op - the operation (OP_CREATE, OP_UPDATE, ...)
        mbr - the member which requests the write operation
        context - a map which contains context parameters (may be null)
      • getInstance

        public static FileDocument getInstance​(java.lang.String filename)
        Constructs a FileDocument from an existing file. The FileDocument is not created in the store.
        Parameters:
        filename - the filename. It must be relative to the context path
        Returns:
        a FileDocument wrapped to the given file or null if this file does not exist
        Since:
        jcms-6.2.0
      • getInstance

        public static FileDocument getInstance​(java.lang.String filename,
                                               Member author,
                                               Workspace ws)
        Constructs a FileDocument from an existing file. The FileDocument is not created in the store.
        Parameters:
        filename - the filename. It must be relative to the context path
        author - the author of the document or null
        ws - the workspace of the publication
        Returns:
        a FileDocument wrapped to the given file or null if this file does not exist
        Since:
        jcms-6.2.0
      • getInstance

        public static FileDocument getInstance​(java.lang.String filename,
                                               java.lang.String title,
                                               java.lang.String description,
                                               Category[] categories)
        Constructs a FileDocument from an existing file. The FileDocument is not created in the store.
        Parameters:
        filename - the filename. It must be relative to the context path
        title - a proposed title (if null, use the name without its extension as title)
        description - the description (may be null)
        categories - the categories (may be null)
        Returns:
        a FileDocument wrapped to the given file or null if this file does not exist
        Since:
        jcms-6.2.0
      • getInstance

        public static FileDocument getInstance​(java.lang.String filename,
                                               java.lang.String title,
                                               java.lang.String description,
                                               Category[] categories,
                                               Member author,
                                               Workspace ws)
        Constructs a FileDocument from an existing file. The FileDocument is not created in the store.
        Parameters:
        filename - the filename. It must be relative to the context path
        title - a proposed title (if null, use the name without its extension as title)
        description - the description (may be null)
        categories - the categories (may be null)
        author - the author of the document or null
        ws - the workspace of the publication
        Returns:
        a FileDocument wrapped to the given file or null if this file does not exist
        Since:
        jcms-6.2.0