com.marklogic.mapreduce

Class LargeBinaryDocument

java.lang.Object

com.marklogic.mapreduce.ForestDocument

com.marklogic.mapreduce.BinaryDocument

com.marklogic.mapreduce.LargeBinaryDocument

All Implemented Interfaces:

MarkLogicDocument, org.apache.hadoop.io.Writable

public class LargeBinaryDocument
extends BinaryDocument

A BinaryDocument representing a large binary document extracted from a forest using Direct Access.

A large binary is stored outside of a MarkLogic fragment. A binary document categorized as "large" when it exceeds the large size threshold configured for a database. For more details, see "Working With Binary Documents" in the MarkLogic Server Application Developer's Guide.

See Also:

ForestInputFormat

Field Summary

Fields

Modifier and Type	Field and Description
protected long	binaryOrigLen
protected org.apache.hadoop.conf.Configuration	conf
static org.apache.commons.logging.Log	LOG
protected long	offset
protected org.apache.hadoop.fs.Path	path
protected long	size

Constructor Summary

Constructors

Constructor and Description
LargeBinaryDocument()
LargeBinaryDocument(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.Path forestDir, ExpandedTree tree)

Method Summary

Modifier and Type	Method and Description
long	getBinaryOrigLen()
byte[]	getContentAsByteArray() Return content as byte array.
byte[]	getContentAsByteArray(int offset, int len)
InputStream	getContentAsByteStream() Return content as byte stream.
MarkLogicNode	getContentAsMarkLogicNode() Return content as MarkLogicNode.
String	getContentAsString() Return content as String.
org.apache.hadoop.io.Text	getContentAsText() Return content as Text.
long	getContentSize() Return byte length of the content.
ContentType	getContentType() Return content type of the document.
long	getOffset()
org.apache.hadoop.fs.Path	getPath()
boolean	isStreamable() Whether the content can be streamed.
void	readFields(DataInput in)
void	write(DataOutput out)

Methods inherited from class com.marklogic.mapreduce.BinaryDocument

createContent

Methods inherited from class com.marklogic.mapreduce.ForestDocument

createDocument, getCollections, getFragmentOrdinal, getMetadata, getQuality, setContentOptions, setQuality

Methods inherited from class java.lang.Object

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

Field Detail

LOG

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

path

protected org.apache.hadoop.fs.Path path

offset

protected long offset

size

protected long size

binaryOrigLen

protected long binaryOrigLen

conf

protected org.apache.hadoop.conf.Configuration conf

Constructor Detail

LargeBinaryDocument

public LargeBinaryDocument()

LargeBinaryDocument

public LargeBinaryDocument(org.apache.hadoop.conf.Configuration conf,
                           org.apache.hadoop.fs.Path forestDir,
                           ExpandedTree tree)

Method Detail

getPath

public org.apache.hadoop.fs.Path getPath()

getOffset

public long getOffset()

getBinaryOrigLen

public long getBinaryOrigLen()

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface MarkLogicDocument

Specified by:

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

Overrides:

readFields in class ForestDocument

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface MarkLogicDocument

Specified by:

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

Overrides:

write in class ForestDocument

Throws:

IOException

getContentAsByteArray

public byte[] getContentAsByteArray()

Description copied from interface: MarkLogicDocument

Return content as byte array.

Returns:

content.

getContentAsByteArray

public byte[] getContentAsByteArray(int offset,
                                    int len)

getContentAsMarkLogicNode

public MarkLogicNode getContentAsMarkLogicNode()

Description copied from interface: MarkLogicDocument

Return content as MarkLogicNode.

Returns:

content.

getContentAsText

public org.apache.hadoop.io.Text getContentAsText()

Description copied from interface: MarkLogicDocument

Return content as Text.

Returns:

content.

getContentType

public ContentType getContentType()

Description copied from interface: MarkLogicDocument

Return content type of the document.

Returns:

content type of the document.

getContentAsString

public String getContentAsString()
                          throws UnsupportedEncodingException

Description copied from interface: MarkLogicDocument

Return content as String.

Returns:

content.

Throws:

UnsupportedEncodingException

getContentAsByteStream

public InputStream getContentAsByteStream()

Description copied from interface: MarkLogicDocument

Return content as byte stream.

Specified by:

getContentAsByteStream in interface MarkLogicDocument

Overrides:

getContentAsByteStream in class ForestDocument

Returns:

content.

getContentSize

public long getContentSize()

Description copied from interface: MarkLogicDocument

Return byte length of the content.

Specified by:

getContentSize in interface MarkLogicDocument

Overrides:

getContentSize in class ForestDocument

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

Overrides:

isStreamable in class ForestDocument

Returns:

true for LargeBinaryDocument, false for the rest.