com.marklogic.mapreduce

Class ForestDocument

java.lang.Object

com.marklogic.mapreduce.ForestDocument

All Implemented Interfaces:

MarkLogicDocument, org.apache.hadoop.io.Writable

Direct Known Subclasses:

BinaryDocument, DOMDocument, JSONDocument

public abstract class ForestDocument
extends Object
implements MarkLogicDocument

A MarkLogicDocument retrieved from a MarkLogic forest through Direct Access.

See Also:

ForestInputFormat

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	LOG

Constructor Summary

Constructors

Constructor and Description
ForestDocument()

Method Summary

Modifier and Type	Method and Description
abstract com.marklogic.xcc.Content	createContent(String uri, com.marklogic.xcc.ContentCreateOptions options, boolean copyCollections, boolean copyMetadata, boolean copyQuality)
static ForestDocument	createDocument(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.Path forestDir, ExpandedTree tree, String uri)
String[]	getCollections()
InputStream	getContentAsByteStream() Return content as byte stream.
long	getContentSize() Return byte length of the content.
long	getFragmentOrdinal()
Map<String,String>	getMetadata()
int	getQuality()
boolean	isStreamable() Whether the content can be streamed.
void	readFields(DataInput in)
protected void	setContentOptions(com.marklogic.xcc.ContentCreateOptions options, boolean copyCollections, boolean copyMetadata, boolean copyQuality)
void	setQuality(int quality)
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.marklogic.mapreduce.MarkLogicDocument

getContentAsByteArray, getContentAsMarkLogicNode, getContentAsString, getContentAsText, getContentType

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

Constructor Detail

ForestDocument

public ForestDocument()

Method Detail

createDocument

public static ForestDocument createDocument(org.apache.hadoop.conf.Configuration conf,
                                            org.apache.hadoop.fs.Path forestDir,
                                            ExpandedTree tree,
                                            String uri)

getFragmentOrdinal

public long getFragmentOrdinal()

getCollections

public String[] getCollections()

getMetadata

public Map<String,String> getMetadata()

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface MarkLogicDocument

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException

getQuality

public int getQuality()

setQuality

public void setQuality(int quality)

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface MarkLogicDocument

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException

getContentAsByteStream

public InputStream getContentAsByteStream()

Description copied from interface: MarkLogicDocument

Return content as byte stream.

Specified by:

getContentAsByteStream in interface MarkLogicDocument

Returns:

content.

getContentSize

public long getContentSize()

Description copied from interface: MarkLogicDocument

Return byte length of the content.

Specified by:

getContentSize in interface MarkLogicDocument

Returns:

byte length of the content.

isStreamable

public boolean isStreamable()

Description copied from interface: MarkLogicDocument

Whether the content can be streamed.

Specified by:

isStreamable in interface MarkLogicDocument

Returns:

true for LargeBinaryDocument, false for the rest.

createContent

public abstract com.marklogic.xcc.Content createContent(String uri,
                                                        com.marklogic.xcc.ContentCreateOptions options,
                                                        boolean copyCollections,
                                                        boolean copyMetadata,
                                                        boolean copyQuality)
                                                 throws IOException

Throws:

IOException

setContentOptions

protected void setContentOptions(com.marklogic.xcc.ContentCreateOptions options,
                                 boolean copyCollections,
                                 boolean copyMetadata,
                                 boolean copyQuality)