com.lucidworks.fusion.connector.plugin.api.fetcher.type.content

Class Document

java.lang.Object

com.lucidworks.fusion.connector.plugin.api.fetcher.type.content.Document

All Implemented Interfaces:

EmittedItem, Fields, Identifiable, Message, Metadata, OutputItem, java.io.Serializable

public class Document
extends java.lang.Object
implements EmittedItem, Fields, Metadata

A Document represents content that will eventually be indexed into the main content Collection. Documents have an ID, metadata, fields and an optional canonical ID.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.Builder
static class	Document.Emitter

Method Summary

Modifier and Type	Method and Description
static Document.Builder	builder(java.lang.String id)
static Document.Emitter	emitter(java.lang.String id, java.util.function.Consumer<EmittedItem> emittedItemConsumer) Creates a document emitter
java.util.List<java.lang.String>	getAcls()
java.lang.String	getCanonicalId()
java.util.Map<java.lang.String,java.lang.Object>	getFields()
java.lang.String	getId()
java.util.Map<java.lang.String,java.lang.Object>	getMetadata()
java.lang.String	getParentId()
boolean	isUpdateACLsOnAncestorChange()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.lucidworks.fusion.connector.plugin.api.fetcher.message.Fields

hasFields

Methods inherited from interface com.lucidworks.fusion.connector.plugin.api.fetcher.message.Metadata

hasMetadata

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface Identifiable

getMetadata

public java.util.Map<java.lang.String,java.lang.Object> getMetadata()

Specified by:

getMetadata in interface Metadata

getFields

public java.util.Map<java.lang.String,java.lang.Object> getFields()

Specified by:

getFields in interface Fields

getParentId

public java.lang.String getParentId()

getCanonicalId

public java.lang.String getCanonicalId()

getAcls

public java.util.List<java.lang.String> getAcls()

isUpdateACLsOnAncestorChange

public boolean isUpdateACLsOnAncestorChange()

builder

public static Document.Builder builder(java.lang.String id)

emitter

public static Document.Emitter emitter(java.lang.String id,
                                       java.util.function.Consumer<EmittedItem> emittedItemConsumer)

Creates a document emitter

Parameters:

id - id

emittedItemConsumer - emitted item consumer

Returns:

document emitter

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object