com.marklogic.mapreduce

Class DatabaseDocument

java.lang.Object

com.marklogic.mapreduce.DatabaseDocument

All Implemented Interfaces:

InternalConstants, MarkLogicDocument, org.apache.hadoop.io.Writable

public class DatabaseDocument
extends Object
implements MarkLogicDocument, InternalConstants

A MarkLogicDocument retrieved from a database via MarkLogic Server.

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	content
protected ContentType	contentType
protected InputStream	is
static org.apache.commons.logging.Log	LOG

Fields inherited from interface com.marklogic.mapreduce.InternalConstants

MAX_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
DatabaseDocument()

Method Summary

Modifier and Type	Method and Description
byte[]	getContentAsByteArray() Return content as byte array.
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.
boolean	isStreamable() Whether the content can be streamed.
void	readFields(DataInput in)
void	set(com.marklogic.xcc.ResultItem item)
void	setContent(byte[] content)
void	setContentType(ContentType type)
void	write(DataOutput out)

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

content

protected byte[] content

is

protected InputStream is

contentType

protected ContentType contentType

Constructor Detail

DatabaseDocument

public DatabaseDocument()

Method Detail

getContentType

public ContentType getContentType()

Description copied from interface: MarkLogicDocument

Return content type of the document.

Specified by:

getContentType in interface MarkLogicDocument

Returns:

content type of the document.

getContentAsText

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

Description copied from interface: MarkLogicDocument

Return content as Text.

Specified by:

getContentAsText in interface MarkLogicDocument

Returns:

content.

getContentAsByteArray

public byte[] getContentAsByteArray()

Description copied from interface: MarkLogicDocument

Return content as byte array.

Specified by:

getContentAsByteArray in interface MarkLogicDocument

Returns:

content.

getContentAsByteStream

public InputStream getContentAsByteStream()

Description copied from interface: MarkLogicDocument

Return content as byte stream.

Specified by:

getContentAsByteStream in interface MarkLogicDocument

Returns:

content.

getContentAsMarkLogicNode

public MarkLogicNode getContentAsMarkLogicNode()

Description copied from interface: MarkLogicDocument

Return content as MarkLogicNode.

Specified by:

getContentAsMarkLogicNode in interface MarkLogicDocument

Returns:

content.

getContentAsString

public String getContentAsString()
                          throws UnsupportedEncodingException

Description copied from interface: MarkLogicDocument

Return content as String.

Specified by:

getContentAsString in interface MarkLogicDocument

Returns:

content.

Throws:

UnsupportedEncodingException

set

public void set(com.marklogic.xcc.ResultItem item)

setContent

public void setContent(byte[] content)

setContentType

public void setContentType(ContentType type)

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

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

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.