Package com.kodexa.client

Class Document

java.lang.Object

com.kodexa.client.Document

public class Document
extends Object

A Kodexa document is a representation of a set of content which combines content, metadata and features it is the core model for handling content

Field Summary

Fields

Modifier and Type	Field	Description
static String	CURRENT_VERSION

Constructor Summary

Constructors

Constructor	Description
Document()
Document(File kddbFile)
Document(InputStream kddbInputStream)

Method Summary

Modifier and Type	Method	Description
Document	addLabel(String label)	Add the given label to the document
void	addMixin(String spatial)
protected boolean	canEqual(Object other)
void	close()
ContentNode	createContentNode(String type, String content)
boolean	equals(Object o)
static Document	fromBytes(byte[] bytes)
static Document	fromInputStream(InputStream inputStream)
static Document	fromJson(String json)	Deprecated.
static Document	fromKddb(File file)
static Document	fromMsgPack(byte[] bytes)	Deprecated.
static Document	fromMsgPack(File file)	Deprecated.
static Document	fromMsgPack(InputStream is)	Deprecated.
static Document	fromText(String text)
static Document	fromUrl(String url)
List<ContentClassification>	getClasses()
ContentNode	getContentNode()
List<String>	getLabels()
Map<String,Object>	getMetadata()
List<String>	getMixins()
ContentNode	getNodeByUuid(String uuid)
long	getNodeCountByType(String type)
protected SqlitePersistenceLayer	getPersistanceLayer()
SqlitePersistenceLayer	getPersistenceLayer()
SourceMetadata	getSource()
List<ContentNode>	getTaggedNodeByTagUuid(String tagUuid)
List<ContentNode>	getTaggedNodes()
List<String>	getTaxonomies()
String	getUuid()
String	getVersion()
int	hashCode()
boolean	isVirtual()
Document	removeLabel(String label)	Remove the given label to the document
void	setClasses(List<ContentClassification> classes)
void	setContentNode(ContentNode contentNode)
void	setLabels(List<String> labels)
void	setMetadata(Map<String,Object> metadata)
void	setMixins(List<String> mixins)
void	setPersistenceLayer(SqlitePersistenceLayer persistenceLayer)
void	setSource(SourceMetadata source)
void	setTaxonomies(List<String> taxonomies)
void	setUuid(String uuid)
void	setVersion(String version)
void	setVirtual(boolean virtual)
byte[]	toBytes()
org.apache.commons.lang3.tuple.ImmutablePair<InputStream,Long>	toInputStream()
String	toJson()	Deprecated.
String	toJson(boolean pretty)	Deprecated.
byte[]	toMsgPack()	Deprecated.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CURRENT_VERSION

public static final String CURRENT_VERSION

See Also:

Constant Field Values

Constructor Detail

Document

public Document()

Document

public Document(InputStream kddbInputStream)

Document

public Document(File kddbFile)

Method Detail

getNodeCountByType

public long getNodeCountByType(String type)

getTaggedNodes

public List<ContentNode> getTaggedNodes()

getNodeByUuid

public ContentNode getNodeByUuid(String uuid)

getTaggedNodeByTagUuid

public List<ContentNode> getTaggedNodeByTagUuid(String tagUuid)

fromJson

@Deprecated
public static Document fromJson(String json)

Deprecated.

Create a new instance of a Document from JSON string

Parameters:

json - String representation of the document JSON

Returns:

De-serialized Document

fromMsgPack

@Deprecated
public static Document fromMsgPack(byte[] bytes)

Deprecated.

Create a Document from a message packed (kdx) representation

Parameters:

bytes - the bytes for the message packed document

Returns:

An instance of a Document

fromMsgPack

@Deprecated
public static Document fromMsgPack(InputStream is)

Deprecated.

Create a Document from a message packed (kdx) representation

Parameters:

is - Input stream containing the document

Returns:

An instance of a Document

fromMsgPack

@Deprecated
public static Document fromMsgPack(File file)

Deprecated.

Create a Document from a message packed (kdx) representation

Parameters:

file - file containing the document

Returns:

An instance of a Document

fromText

public static Document fromText(String text)

getPersistanceLayer

protected SqlitePersistenceLayer getPersistanceLayer()

fromUrl

public static Document fromUrl(String url)

fromKddb

public static Document fromKddb(File file)

fromInputStream

public static Document fromInputStream(InputStream inputStream)

fromBytes

public static Document fromBytes(byte[] bytes)

toBytes

public byte[] toBytes()

toInputStream

public org.apache.commons.lang3.tuple.ImmutablePair<InputStream,Long> toInputStream()

close

public void close()

addLabel

public Document addLabel(String label)

Add the given label to the document

Parameters:

label - the label to add

Returns:

the instance of the document

removeLabel

public Document removeLabel(String label)

Remove the given label to the document

Parameters:

label - the label to remove

Returns:

the instance of the document

toJson

@Deprecated
public String toJson(boolean pretty)

Deprecated.

Convert the document to JSON

Parameters:

pretty - include spacing and new lines if true

Returns:

JSON representation of document

toMsgPack

@Deprecated
public byte[] toMsgPack()

Deprecated.

Create a message pack representation of this document

Returns:

Byte array of the document packed

toJson

@Deprecated
public String toJson()

Deprecated.

Create a JSON representation of this document

Returns:

String containing the JSON representation

createContentNode

public ContentNode createContentNode(String type,
                                     String content)

addMixin

public void addMixin(String spatial)

getPersistenceLayer

public SqlitePersistenceLayer getPersistenceLayer()

getMetadata

public Map<String,Object> getMetadata()

getSource

public SourceMetadata getSource()

getContentNode

public ContentNode getContentNode()

isVirtual

public boolean isVirtual()

getMixins

public List<String> getMixins()

getLabels

public List<String> getLabels()

getTaxonomies

public List<String> getTaxonomies()

getClasses

public List<ContentClassification> getClasses()

getUuid

public String getUuid()

getVersion

public String getVersion()

setPersistenceLayer

public void setPersistenceLayer(SqlitePersistenceLayer persistenceLayer)

setMetadata

public void setMetadata(Map<String,Object> metadata)

setSource

public void setSource(SourceMetadata source)

setContentNode

public void setContentNode(ContentNode contentNode)

setVirtual

public void setVirtual(boolean virtual)

setMixins

public void setMixins(List<String> mixins)

setLabels

public void setLabels(List<String> labels)

setTaxonomies

public void setTaxonomies(List<String> taxonomies)

setClasses

public void setClasses(List<ContentClassification> classes)

setUuid

public void setUuid(String uuid)

setVersion

public void setVersion(String version)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object