Package com.marklogic.contentpump
Class DocumentMetadata
- java.lang.Object
-
- com.marklogic.contentpump.DocumentMetadata
-
public class DocumentMetadata extends Object
Metadata of a MarkLogicDocument, includes properties, permissions, quality and collections.
-
-
Field Summary
Fields Modifier and Type Field Description protected List<String>collectionsListstatic StringEXTENSIONsuffix of the URI of metadataprotected com.marklogic.xcc.DocumentFormatformatprotected booleanisNakedPropsprotected Map<String,String>metastatic StringNAKEDsuffix of the URI of naked propertiesprotected List<com.marklogic.xcc.ContentPermission>permissionsListprotected StringpermStringprotected Stringpropertiesprotected intquality
-
Constructor Summary
Constructors Constructor Description DocumentMetadata()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddCollection(String _collection)voidaddCollections(String[] _collections)voidaddPermission(com.marklogic.xcc.ContentPermission _permission)voidaddPermission(String _capability, String _role, String _id)voidaddPermissions(Collection<com.marklogic.xcc.ContentPermission> permissions)voidclearPermissions()voidclearProperties()booleanequals(Object obj)static DocumentMetadatafromXML(Reader reader)String[]getCollections()StringgetCollectionString()com.marklogic.xcc.DocumentFormatgetFormat()StringgetFormatName()Map<String,String>getMeta()com.marklogic.xcc.ContentPermission[]getPermissions()StringgetPermString()StringgetProperties()intgetQuality()StringgetQualityString()booleanisBinary()booleanisNakedProps()booleanisText()booleanisXml()voidsetFormat(com.marklogic.xcc.DocumentFormat _format)voidsetFormat(String _format)voidsetMeta(Map<String,String> meta)voidsetNakedProps(boolean isNakedProps)voidsetPermString(String permString)voidsetProperties(String _properties)voidsetQuality(int _quality)voidsetQuality(com.marklogic.xcc.types.XSInteger integer)StringtoXML()
-
-
-
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
-
permissionsList
protected List<com.marklogic.xcc.ContentPermission> permissionsList
-
permString
protected String permString
-
quality
protected int quality
-
properties
protected String properties
-
isNakedProps
protected boolean isNakedProps
-
-
Method Detail
-
isNakedProps
public boolean isNakedProps()
-
setNakedProps
public void setNakedProps(boolean isNakedProps)
-
fromXML
public static DocumentMetadata fromXML(Reader reader)
- Parameters:
reader-
-
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-
-
-