com.lucidworks.apollo.component

Class PipelineDocumentUtils

java.lang.Object

com.lucidworks.apollo.component.PipelineDocumentUtils

public class PipelineDocumentUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PipelineDocumentUtils()

Method Summary

Modifier and Type	Method and Description
static SolrInputDocument	convertPipelineDocumentToSolr(PipelineDocument doc)
static PipelineDocument	convertSolrInputDocumentToPipelineDocument(SolrInputDocument solrDoc)
static PipelineDocument	flatten(PipelineDocument doc) Flatten the structure of document.
static PipelineDocument	flatten(PipelineDocument doc, boolean handleListsIndexNumbered) Flatten the structure of document.
static PipelineDocument	fromEventMap(java.util.Map<java.lang.CharSequence,java.lang.Object> map)
static PipelineDocument	fromMap(java.util.Map<?,?> map)
static PipelineDocument	fromMap(java.util.Map<?,?> map, boolean handleListsIndexNumbered)
static PipelineDocument	fromMap(java.util.Map<?,?> map, PipelineDocument template, boolean handleListsIndexNumbered)
static PipelineDocument	fromSolrDocument(SolrDocument sd)
static boolean	isCommandsDocument(PipelineDocument pipelineDocument) Return true if the given pipeline document is a special "Commands" document.
static PipelineDocument	mapToPipelineDocument(java.util.Map<java.lang.String,java.lang.Object> entry)
static java.io.InputStream	objectToInputStream(java.lang.Object input)
static void	prefixPipelineDocumentFields(PipelineDocument doc, java.lang.String prefix) put the prefix infront of every field within the pipeline doc
static java.util.Map<java.lang.String,java.lang.Object>	toMap(PipelineDocument doc)

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineDocumentUtils

public PipelineDocumentUtils()

Method Detail

prefixPipelineDocumentFields

public static void prefixPipelineDocumentFields(PipelineDocument doc,
                                                java.lang.String prefix)

put the prefix infront of every field within the pipeline doc

Parameters:

doc -

prefix -

fromSolrDocument

public static PipelineDocument fromSolrDocument(SolrDocument sd)

toMap

public static java.util.Map<java.lang.String,java.lang.Object> toMap(PipelineDocument doc)

fromEventMap

public static PipelineDocument fromEventMap(java.util.Map<java.lang.CharSequence,java.lang.Object> map)

fromMap

public static PipelineDocument fromMap(java.util.Map<?,?> map)

fromMap

public static PipelineDocument fromMap(java.util.Map<?,?> map,
                                       boolean handleListsIndexNumbered)

fromMap

public static PipelineDocument fromMap(java.util.Map<?,?> map,
                                       PipelineDocument template,
                                       boolean handleListsIndexNumbered)

flatten

public static PipelineDocument flatten(PipelineDocument doc)

Flatten the structure of document. Flatten lists into a multivalued field. See flatten(PipelineDocument, boolean) for more info

flatten

public static PipelineDocument flatten(PipelineDocument doc,
                                       boolean handleListsIndexNumbered)

Flatten the structure of document. For each field in the document it checks the value of the field and converts it (recursively) to multiple fields under the following conditions:

• field is an array or collection: if all values are flat then they will be added as multiple fields with the same name. Otherwise, if handleListsIndexNumbered is true then an index (starting from 0) will be appended to the field name, and values will be further flattened recursively.
• field is a map: keys will be appended to the field name, and values will be further flattened recursively.

Parameters:

doc - input document, possibly containing nested data

handleListsIndexNumbered - is a flag to flatten lists into index numbered fields

Returns:

new instance of flattened document, or the original document if it was already flattened.

convertSolrInputDocumentToPipelineDocument

public static PipelineDocument convertSolrInputDocumentToPipelineDocument(SolrInputDocument solrDoc)

convertPipelineDocumentToSolr

public static SolrInputDocument convertPipelineDocumentToSolr(PipelineDocument doc)

isCommandsDocument

public static boolean isCommandsDocument(PipelineDocument pipelineDocument)

Return true if the given pipeline document is a special "Commands" document. The latter is defined as a document that contains no fields but does contain command(s).

Parameters:

pipelineDocument - Document to check.

Returns:

True if document is considered a "Commands" document, otherwise false.

objectToInputStream

public static java.io.InputStream objectToInputStream(java.lang.Object input)

mapToPipelineDocument

public static PipelineDocument mapToPipelineDocument(java.util.Map<java.lang.String,java.lang.Object> entry)