com.lucidworks.apollo.common.pipeline

Class PipelineDocument

java.lang.Object

com.lucidworks.apollo.common.pipeline.PipelineDocument

All Implemented Interfaces:

Aggregatable, Copyable<PipelineDocument>, Serializable

public class PipelineDocument
extends Object
implements Aggregatable, Serializable, Copyable<PipelineDocument>

Fusion internal representation of a "SolrDocument". Please note that if you change this class in ways that affect the serialized form (adding fields, for example) you need to change the deserialization code in GenericJSONDocumentMessageReader.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ALL_RESERVED_PREFIXES
static String	F_RAW_CONTENT
static String	F_RESERVED_PREFIX
static String	F_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
PipelineDocument()
PipelineDocument(PipelineDocument other)
PipelineDocument(String id)
PipelineDocument(String id, List<PipelineField> fields, Map<String,String> metadata, List<Command> commands, Map<String,Set<String>> hints)

Method Summary

Modifier and Type	Method and Description
PipelineDocument	addCommand(Command c)
PipelineDocument	addCommand(String cmd, Map<String,String> params)
void	addCommands(List<Command> commands)
PipelineDocument	addField(PipelineField fld)
PipelineDocument	addField(String name, Object value) This will add a field to the document.
PipelineDocument	addField(String name, Object value, List<Annotation> annotations)
PipelineDocument	addField(String name, Object value, String... meta)
PipelineDocument	addFieldIfDifferent(PipelineField fld)
PipelineDocument	addFieldIfDifferent(String name, Object value, List<Annotation> annotations)
PipelineDocument	addFieldIfDifferent(String name, Object value, String... meta)
PipelineDocument	addFields(Collection<PipelineField> fields)
Aggregatable	addFields(String field, Collection<?> values)
PipelineDocument	addHint(String name, String tag)
PipelineDocument	addHints(String name, Collection<String> tags)
PipelineDocument	addHints(String name, String... tags)
PipelineDocument	addMetadata(String name, String value)
Aggregatable	clear()
void	copyField(String src, String dest)
PipelineDocument	copyOf()
boolean	equals(Object o)
Set<String>	getAllFieldNames() This method returns all field names, including those that are reserved for internal use.
List<Command>	getCommands()
byte[]	getContent()
Set<String>	getFieldNames() This method returns a subset of field names excluding those that are reserved for internal use.
Map<String,List<PipelineField>>	getFields() Return all fields as an (unmodifiable) Map.
List<PipelineField>	getFields(String name)
List<Object>	getFieldValues(String name)
Set<String>	getFilteredFieldNames(String... excludePrefixes) Returns a filtered subset of field names, where names that start with one of excludePrefixes are excluded.
PipelineField	getFirstField(String name)
Object	getFirstFieldValue(String name)
List<PipelineField>	getFlattenedFields()
Map<String,Set<String>>	getHints()
Set<String>	getHints(String name)
String	getId()
PipelineField	getLastField(String name)
Map<String,String>	getMetadata()
String	getMetadata(String name)
Set<String>	getMetadataNames()
Set<String>	getReservedFieldNames() This method returns a subset of field names that are reserved for internal use, i.e.
boolean	hasField(String name) Return true if this document has the given field.
int	hashCode()
boolean	hasHint(String name, String tag)
boolean	hasMetadata(String name)
static String	metadataKey(String type, String name, String... additionalNames) Prefix a key with our reserved prefix F_RESERVED_PREFIX and join remaining parts with underscores
static PipelineDocument	newCommit()
static PipelineDocument	newCommit(Map<String,String> params)
static PipelineDocument	newDelete(String id, boolean commit)
static PipelineDocument	newDelete(String id, int commitWithin)
static PipelineDocument	newDeleteById(String id, Map<String,String> inputParams)
static PipelineDocument	newDeleteByQuery(String query, boolean commit)
static PipelineDocument	newDeleteByQuery(String query, Map<String,String> inputParams)
static PipelineDocument	newDocument()
static PipelineDocument	newDocument(String id)
static PipelineDocument	newOptimize(Map<String,String> params)
Set<String>	removeAllHints(String name)
PipelineDocument	removeCommands()
PipelineDocument	removeFields(String name) Remove all fields from document that match the given field name.
boolean	removeHint(String name, String tag)
boolean	removeHints(String name, Collection<String> tags)
boolean	removeHints(String name, String... tags)
PipelineDocument	removeMetadata(String name)
void	renameField(String name, String newName)
void	setContent(byte[] data)
PipelineDocument	setField(String name, Object value) Set the value of the given field to the given value.
PipelineDocument	setField(String name, Object value, List<Annotation> annotations)
PipelineDocument	setField(String name, Object value, String... meta)
void	setFields(Map<String,List<PipelineField>> fields) Set all fields for this document by clearing existing fields and adding all content from the given fields Map.
Aggregatable	setFields(String field, Collection<?> values)
PipelineDocument	setHints(String name, Collection<String> tags)
PipelineDocument	setHints(String name, String... tags)
PipelineDocument	setId(String id)
void	setMetadata(Map<String,String> metadata)
PipelineDocument	setUpdateModifier(String fieldName, UpdateModifier updateModifier)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

F_RAW_CONTENT

public static final String F_RAW_CONTENT

See Also:

Constant Field Values

F_RESERVED_PREFIX

public static final String F_RESERVED_PREFIX

See Also:

Constant Field Values

ALL_RESERVED_PREFIXES

public static final String[] ALL_RESERVED_PREFIXES

F_SEPARATOR

public static final String F_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

PipelineDocument

public PipelineDocument()

PipelineDocument

public PipelineDocument(String id)

PipelineDocument

public PipelineDocument(String id,
                        List<PipelineField> fields,
                        Map<String,String> metadata,
                        List<Command> commands,
                        Map<String,Set<String>> hints)

PipelineDocument

public PipelineDocument(PipelineDocument other)

Method Detail

copyOf

public PipelineDocument copyOf()

Specified by:

copyOf in interface Copyable<PipelineDocument>

getId

public String getId()

getMetadata

public Map<String,String> getMetadata()

getMetadata

public String getMetadata(String name)

hasMetadata

public boolean hasMetadata(String name)

getMetadataNames

public Set<String> getMetadataNames()

setMetadata

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

addMetadata

public PipelineDocument addMetadata(String name,
                                    String value)

removeMetadata

public PipelineDocument removeMetadata(String name)

addHint

public PipelineDocument addHint(String name,
                                String tag)

addHints

public PipelineDocument addHints(String name,
                                 Collection<String> tags)

addHints

public PipelineDocument addHints(String name,
                                 String... tags)

setHints

public PipelineDocument setHints(String name,
                                 Collection<String> tags)

setHints

public PipelineDocument setHints(String name,
                                 String... tags)

getHints

public Set<String> getHints(String name)

hasHint

public boolean hasHint(String name,
                       String tag)

getHints

public Map<String,Set<String>> getHints()

removeHint

public boolean removeHint(String name,
                          String tag)

removeHints

public boolean removeHints(String name,
                           String... tags)

removeHints

public boolean removeHints(String name,
                           Collection<String> tags)

removeAllHints

public Set<String> removeAllHints(String name)

setUpdateModifier

public PipelineDocument setUpdateModifier(String fieldName,
                                          UpdateModifier updateModifier)

renameField

public void renameField(String name,
                        String newName)

copyField

public void copyField(String src,
                      String dest)

clear

public Aggregatable clear()

Specified by:

clear in interface Aggregatable

getFields

public Map<String,List<PipelineField>> getFields()

Return all fields as an (unmodifiable) Map.

getAllFieldNames

public Set<String> getAllFieldNames()

This method returns all field names, including those that are reserved for internal use.

getFieldNames

public Set<String> getFieldNames()

This method returns a subset of field names excluding those that are reserved for internal use. It's equivalent to calling getFilteredFieldNames(String...) and passing F_RESERVED_PREFIX as argument.

Specified by:

getFieldNames in interface Aggregatable

getReservedFieldNames

public Set<String> getReservedFieldNames()

This method returns a subset of field names that are reserved for internal use, i.e. field name starts with ALL_RESERVED_PREFIXES

getFilteredFieldNames

public Set<String> getFilteredFieldNames(String... excludePrefixes)

Returns a filtered subset of field names, where names that start with one of excludePrefixes are excluded.

hasField

public boolean hasField(String name)

Return true if this document has the given field.

Parameters:

name - field name to check for

Returns:

true if field is present, otherwise false.

setFields

public void setFields(Map<String,List<PipelineField>> fields)

Set all fields for this document by clearing existing fields and adding all content from the given fields Map.

Parameters:

fields - Map of fields to set in this document.

addField

public PipelineDocument addField(String name,
                                 Object value)

This will add a field to the document. If fields already exist with this name it will append the value to the collection.

Specified by:

addField in interface Aggregatable

Parameters:

name - field name (key)

value - value to add

Returns:

a version of this document with the specified field added.

addFields

public Aggregatable addFields(String field,
                              Collection<?> values)

Specified by:

addFields in interface Aggregatable

addField

public PipelineDocument addField(String name,
                                 Object value,
                                 String... meta)

addField

public PipelineDocument addField(String name,
                                 Object value,
                                 List<Annotation> annotations)

addField

public PipelineDocument addField(PipelineField fld)

addFieldIfDifferent

public PipelineDocument addFieldIfDifferent(String name,
                                            Object value,
                                            String... meta)

addFieldIfDifferent

public PipelineDocument addFieldIfDifferent(String name,
                                            Object value,
                                            List<Annotation> annotations)

addFieldIfDifferent

public PipelineDocument addFieldIfDifferent(PipelineField fld)

addFields

public PipelineDocument addFields(Collection<PipelineField> fields)

removeFields

public PipelineDocument removeFields(String name)

Remove all fields from document that match the given field name.

Specified by:

removeFields in interface Aggregatable

Parameters:

name - name of field to remove

Returns:

a version of this document with the specified fields removed.

setField

public PipelineDocument setField(String name,
                                 Object value)

Set the value of the given field to the given value.

Specified by:

setField in interface Aggregatable

Parameters:

name - field name (key)

value - value to add

Returns:

a version of this document with the specified field value set.

setFields

public Aggregatable setFields(String field,
                              Collection<?> values)

Specified by:

setFields in interface Aggregatable

setField

public PipelineDocument setField(String name,
                                 Object value,
                                 String... meta)

setField

public PipelineDocument setField(String name,
                                 Object value,
                                 List<Annotation> annotations)

getFields

public List<PipelineField> getFields(String name)

getFieldValues

public List<Object> getFieldValues(String name)

Specified by:

getFieldValues in interface Aggregatable

getFirstField

public PipelineField getFirstField(String name)

getFirstFieldValue

public Object getFirstFieldValue(String name)

Specified by:

getFirstFieldValue in interface Aggregatable

getLastField

public PipelineField getLastField(String name)

getFlattenedFields

public List<PipelineField> getFlattenedFields()

setId

public PipelineDocument setId(String id)

getContent

public byte[] getContent()

setContent

public void setContent(byte[] data)

getCommands

public List<Command> getCommands()

addCommands

public void addCommands(List<Command> commands)

addCommand

public PipelineDocument addCommand(String cmd,
                                   Map<String,String> params)

addCommand

public PipelineDocument addCommand(Command c)

removeCommands

public PipelineDocument removeCommands()

newDelete

public static PipelineDocument newDelete(String id,
                                         boolean commit)

newDelete

public static PipelineDocument newDelete(String id,
                                         int commitWithin)

newDocument

public static PipelineDocument newDocument()

newDocument

public static PipelineDocument newDocument(String id)

newDeleteByQuery

public static PipelineDocument newDeleteByQuery(String query,
                                                Map<String,String> inputParams)

newDeleteById

public static PipelineDocument newDeleteById(String id,
                                             Map<String,String> inputParams)

newDeleteByQuery

public static PipelineDocument newDeleteByQuery(String query,
                                                boolean commit)

newCommit

public static PipelineDocument newCommit()

newCommit

public static PipelineDocument newCommit(Map<String,String> params)

newOptimize

public static PipelineDocument newOptimize(Map<String,String> params)

metadataKey

public static String metadataKey(String type,
                                 String name,
                                 String... additionalNames)

Prefix a key with our reserved prefix F_RESERVED_PREFIX and join remaining parts with underscores

Parameters:

type - The "type" of this key, e.g. "parser", "datasource", etc

name - The name of the key

additionalNames - Additional names to append to this key

Returns:

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object