public abstract class ForestDocument extends Object implements MarkLogicDocument
MarkLogicDocument retrieved from a MarkLogic forest through
Direct Access.ForestInputFormat| Modifier and Type | Field and Description |
|---|---|
static org.apache.commons.logging.Log |
LOG |
| Constructor and Description |
|---|
ForestDocument() |
| 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) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetContentAsByteArray, getContentAsMarkLogicNode, getContentAsString, getContentAsText, getContentTypepublic static ForestDocument createDocument(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.Path forestDir, ExpandedTree tree, String uri)
public long getFragmentOrdinal()
public String[] getCollections()
public void readFields(DataInput in) throws IOException
readFields in interface MarkLogicDocumentreadFields in interface org.apache.hadoop.io.WritableIOExceptionpublic int getQuality()
public void setQuality(int quality)
public void write(DataOutput out) throws IOException
write in interface MarkLogicDocumentwrite in interface org.apache.hadoop.io.WritableIOExceptionpublic InputStream getContentAsByteStream()
MarkLogicDocumentgetContentAsByteStream in interface MarkLogicDocumentpublic long getContentSize()
MarkLogicDocumentgetContentSize in interface MarkLogicDocumentpublic boolean isStreamable()
MarkLogicDocumentisStreamable in interface MarkLogicDocumentpublic abstract com.marklogic.xcc.Content createContent(String uri, com.marklogic.xcc.ContentCreateOptions options, boolean copyCollections, boolean copyMetadata, boolean copyQuality) throws IOException
IOExceptionprotected void setContentOptions(com.marklogic.xcc.ContentCreateOptions options,
boolean copyCollections,
boolean copyMetadata,
boolean copyQuality)
Copyright © 2024 MarkLogic Corporation
Complete online documentation for MarkLogic Server, XQuery and related components may be found at developer.marklogic.com