com.exalead.indexing.analysis.v10

Class StorageServiceDocumentProcessor

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.StorageServiceDocumentProcessor

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class StorageServiceDocumentProcessor
extends DocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

Queries the storage for any meta to attach to the document.
Multi-valued pairs are pushed as multi-valued metas.
For example:

• The storage key "nb_comment" will be attached as "nb_comment" meta on the document.
• The storage key "tags[]" will be attached as "tags" multi-valued meta on the document.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

DocumentProcessor.FromDataModel, DocumentProcessor.Transformer<T>

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	instance
java.lang.String	metaIdentifier

Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

acceptCondition, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

Constructor and Description
StorageServiceDocumentProcessor()
StorageServiceDocumentProcessor(StorageServiceDocumentProcessor o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this StorageServiceDocumentProcessor.
static StorageServiceDocumentProcessor	fromString(java.lang.String s) String representation of this StorageServiceDocumentProcessor.
java.lang.String	getInstance() Storage service instance
java.lang.String	getMetaIdentifier() Defines an optional meta name that will be used as storage Identifier instead of the document Uri.
StorageServiceDocumentProcessor	makeCopy() Creates and returns a deep copy of this StorageServiceDocumentProcessor.
static StorageServiceDocumentProcessor	readFrom(java.io.InputStream is) Read this StorageServiceDocumentProcessor from an XML fragment.
void	setInstance(java.lang.String instance) Storage service instance
void	setMetaIdentifier(java.lang.String metaIdentifier) Defines an optional meta name that will be used as storage Identifier instead of the document Uri.
java.lang.String	toString() String representation of this StorageServiceDocumentProcessor.
StorageServiceDocumentProcessor	withAcceptCondition(AcceptCondition acceptCondition)
StorageServiceDocumentProcessor	withDataModelClass(java.lang.String dataModelClass)
StorageServiceDocumentProcessor	withDataModelProperty(java.lang.String dataModelProperty)
StorageServiceDocumentProcessor	withDataModelState(java.lang.String dataModelState)
StorageServiceDocumentProcessor	withDisabled(boolean disabled)
StorageServiceDocumentProcessor	withDisabled(java.lang.Boolean disabled)
StorageServiceDocumentProcessor	withFromDataModel(DocumentProcessor fromDataModel)
StorageServiceDocumentProcessor	withInstance(java.lang.String instance)
StorageServiceDocumentProcessor	withMetaIdentifier(java.lang.String metaIdentifier)
StorageServiceDocumentProcessor	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this StorageServiceDocumentProcessor as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

getAcceptCondition, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setAcceptCondition, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

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

Field Detail

instance

public java.lang.String instance

metaIdentifier

public java.lang.String metaIdentifier

Constructor Detail

StorageServiceDocumentProcessor

public StorageServiceDocumentProcessor()

StorageServiceDocumentProcessor

public StorageServiceDocumentProcessor(StorageServiceDocumentProcessor o)

Copy constructor

Method Detail

withAcceptCondition

public StorageServiceDocumentProcessor withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class DocumentProcessor

withName

public StorageServiceDocumentProcessor withName(java.lang.String name)

Overrides:

withName in class DocumentProcessor

withDataModelState

public StorageServiceDocumentProcessor withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class DocumentProcessor

withFromDataModel

public StorageServiceDocumentProcessor withFromDataModel(DocumentProcessor fromDataModel)

withDataModelClass

public StorageServiceDocumentProcessor withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class DocumentProcessor

withDataModelProperty

public StorageServiceDocumentProcessor withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class DocumentProcessor

withDisabled

public StorageServiceDocumentProcessor withDisabled(boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

withDisabled

public StorageServiceDocumentProcessor withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

setInstance

public void setInstance(java.lang.String instance)

Storage service instance

getInstance

public java.lang.String getInstance()

Storage service instance

withInstance

public StorageServiceDocumentProcessor withInstance(java.lang.String instance)

setMetaIdentifier

public void setMetaIdentifier(java.lang.String metaIdentifier)

Defines an optional meta name that will be used as storage Identifier instead of the document Uri.

getMetaIdentifier

public java.lang.String getMetaIdentifier()

Defines an optional meta name that will be used as storage Identifier instead of the document Uri.

withMetaIdentifier

public StorageServiceDocumentProcessor withMetaIdentifier(java.lang.String metaIdentifier)

makeCopy

public StorageServiceDocumentProcessor makeCopy()

Creates and returns a deep copy of this StorageServiceDocumentProcessor.

Overrides:

makeCopy in class DocumentProcessor

readFrom

public static StorageServiceDocumentProcessor readFrom(java.io.InputStream is)
                                                throws javax.xml.bind.JAXBException

Read this StorageServiceDocumentProcessor from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this StorageServiceDocumentProcessor as an XML fragment

Overrides:

writeTo in class DocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static StorageServiceDocumentProcessor fromString(java.lang.String s)
                                                  throws javax.xml.bind.JAXBException,
                                                         java.io.UnsupportedEncodingException

String representation of this StorageServiceDocumentProcessor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this StorageServiceDocumentProcessor.

Overrides:

toString in class DocumentProcessor

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this StorageServiceDocumentProcessor.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class DocumentProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(DocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class DocumentProcessor

Throws:

com.exalead.util.TypedException