com.marklogic.ps.xqsync

Class XQSyncDocumentMetadata

java.lang.Object

com.marklogic.ps.xqsync.XQSyncDocumentMetadata

All Implemented Interfaces:

MetadataInterface

public class XQSyncDocumentMetadata
extends java.lang.Object
implements MetadataInterface

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	hashValue

Constructor Summary

Constructors

Constructor and Description
XQSyncDocumentMetadata()

Method Summary

Modifier and Type	Method and Description
void	addCollection(java.lang.String collection)
void	addCollections(java.lang.String[] collections)
void	addPermission(com.marklogic.xcc.ContentPermission permission)
void	addPermission(java.lang.String capability, java.lang.String role)
void	addPermissions(java.util.Collection<com.marklogic.xcc.ContentPermission> permissions)
void	clearPermissions()
void	clearProperties()
static XQSyncDocumentMetadata	fromXML(java.io.Reader reader)
java.lang.String[]	getCollections()
com.marklogic.xcc.DocumentFormat	getFormat()
java.lang.String	getFormatName()
java.lang.String	getHashValue()
com.marklogic.xcc.ContentPermission[]	getPermissions()
java.lang.String	getProperties()
int	getQuality()
boolean	isBinary()
boolean	isText()
boolean	isXml()
void	setFormat(com.marklogic.xcc.DocumentFormat format)
void	setFormat(java.lang.String format)
void	setHashValue(java.lang.String hashValue) Set the hash value for this document
void	setProperties(java.lang.String properties)
void	setQuality(int quality)
void	setQuality(com.marklogic.xcc.types.XSInteger integer)
java.lang.String	toXML()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

hashValue

protected java.lang.String hashValue

Constructor Detail

XQSyncDocumentMetadata

public XQSyncDocumentMetadata()

Method Detail

fromXML

public static XQSyncDocumentMetadata fromXML(java.io.Reader reader)

Parameters:

reader -

isBinary

public boolean isBinary()

Specified by:

isBinary in interface MetadataInterface

Returns:

setFormat

public void setFormat(com.marklogic.xcc.DocumentFormat format)

Parameters:

format -

addCollection

public void addCollection(java.lang.String collection)

Specified by:

addCollection in interface MetadataInterface

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(java.lang.String properties)

Specified by:

setProperties in interface MetadataInterface

Parameters:

properties -

getCollections

public java.lang.String[] getCollections()

Returns:

getProperties

public java.lang.String getProperties()

Returns:

addPermissions

public void addPermissions(java.util.Collection<com.marklogic.xcc.ContentPermission> permissions)

Parameters:

permissions -

getPermissions

public com.marklogic.xcc.ContentPermission[] getPermissions()

Returns:

getQuality

public int getQuality()

Returns:

getFormat

public com.marklogic.xcc.DocumentFormat getFormat()

Returns:

toXML

public java.lang.String toXML()

Returns:

clearPermissions

public void clearPermissions()

Specified by:

clearPermissions in interface MetadataInterface

clearProperties

public void clearProperties()

Specified by:

clearProperties in interface MetadataInterface

getFormatName

public java.lang.String getFormatName()

Specified by:

getFormatName in interface MetadataInterface

Returns:

setFormat

public void setFormat(java.lang.String format)

Specified by:

setFormat in interface MetadataInterface

Parameters:

format -

addPermission

public void addPermission(java.lang.String capability,
                          java.lang.String role)

Specified by:

addPermission in interface MetadataInterface

Parameters:

capability -

role -

setQuality

public void setQuality(com.marklogic.xcc.types.XSInteger integer)

Specified by:

setQuality in interface MetadataInterface

Parameters:

integer -

isText

public boolean isText()

Returns:

isXml

public boolean isXml()

Returns:

addCollections

public void addCollections(java.lang.String[] collections)

Parameters:

collections -

setHashValue

public void setHashValue(java.lang.String hashValue)

Set the hash value for this document

Specified by:

setHashValue in interface MetadataInterface

getHashValue

public java.lang.String getHashValue()

Specified by:

getHashValue in interface MetadataInterface

Returns:

the hash value for this document