Class DocumentMetadata


  • public class DocumentMetadata
    extends Object
    Metadata of a MarkLogicDocument, includes properties, permissions, quality and collections.
    • Field Detail

      • EXTENSION

        public static String EXTENSION
        suffix of the URI of metadata
      • NAKED

        public static String NAKED
        suffix of the URI of naked properties
      • format

        protected com.marklogic.xcc.DocumentFormat format
      • collectionsList

        protected List<String> collectionsList
      • permissionsList

        protected List<com.marklogic.xcc.ContentPermission> permissionsList
      • permString

        protected String permString
      • quality

        protected int quality
      • properties

        protected String properties
      • isNakedProps

        protected boolean isNakedProps
    • Constructor Detail

      • DocumentMetadata

        public DocumentMetadata()
    • Method Detail

      • isNakedProps

        public boolean isNakedProps()
      • setNakedProps

        public void setNakedProps​(boolean isNakedProps)
      • isBinary

        public boolean isBinary()
        Returns:
      • setFormat

        public void setFormat​(com.marklogic.xcc.DocumentFormat _format)
        Parameters:
        _format -
      • addCollection

        public void addCollection​(String _collection)
        Parameters:
        _collection -
      • addPermission

        public void addPermission​(com.marklogic.xcc.ContentPermission _permission)
        Parameters:
        _permission -
      • setQuality

        public void setQuality​(int _quality)
        Parameters:
        _quality -
      • setProperties

        public void setProperties​(String _properties)
        Parameters:
        _properties -
      • getCollections

        public String[] getCollections()
        Returns:
      • getCollectionString

        public String getCollectionString()
      • getProperties

        public String getProperties()
        Returns:
      • addPermissions

        public void addPermissions​(Collection<com.marklogic.xcc.ContentPermission> permissions)
        Parameters:
        permissions -
      • getPermissions

        public com.marklogic.xcc.ContentPermission[] getPermissions()
        Returns:
      • getQuality

        public int getQuality()
        Returns:
      • getQualityString

        public String getQualityString()
      • getFormat

        public com.marklogic.xcc.DocumentFormat getFormat()
        Returns:
      • toXML

        public String toXML()
        Returns:
      • clearPermissions

        public void clearPermissions()
      • clearProperties

        public void clearProperties()
      • getFormatName

        public String getFormatName()
      • setFormat

        public void setFormat​(String _format)
        Parameters:
        _format -
      • addPermission

        public void addPermission​(String _capability,
                                  String _role,
                                  String _id)
        Parameters:
        _capability -
        _role -
      • getPermString

        public String getPermString()
      • setPermString

        public void setPermString​(String permString)
      • setQuality

        public void setQuality​(com.marklogic.xcc.types.XSInteger integer)
        Parameters:
        integer -
      • isText

        public boolean isText()
        Returns:
      • isXml

        public boolean isXml()
        Returns:
      • addCollections

        public void addCollections​(String[] _collections)
        Parameters:
        _collections -