com.exalead.search.v30

Class MultiContextField

java.lang.Object

com.exalead.search.v30.AbstractRetrievedField

com.exalead.search.v30.MultiContextField

All Implemented Interfaces:

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

public class MultiContextField
extends AbstractRetrievedField
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	contextName
static boolean	DEFAULT_KEEP_META_NAME
boolean	keepMetaName
java.util.List<MatchRule>	matchRule

Fields inherited from class com.exalead.search.v30.AbstractRetrievedField

indexField, name, type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this MultiContextField.
static MultiContextField	fromString(java.lang.String s) String representation of this MultiContextField.
java.lang.String	getContextName()
java.util.List<MatchRule>	getMatchRule() List of rules to define which document metas should be mapped to this dynamic property.
boolean	isKeepMetaName() When set to true, a key:value stored in the field will create a meta "key" which value is "value".
MultiContextField	makeCopy() Creates and returns a deep copy of this MultiContextField.
static MultiContextField	readFrom(java.io.InputStream is) Read this MultiContextField from an XML fragment.
void	setContextName(java.lang.String contextName)
void	setKeepMetaName(boolean keepMetaName) When set to true, a key:value stored in the field will create a meta "key" which value is "value".
java.lang.String	toString() String representation of this MultiContextField.
MultiContextField	withContextName(java.lang.String contextName)
MultiContextField	withIndexField(java.lang.String indexField)
MultiContextField	withKeepMetaName(boolean keepMetaName)
MultiContextField	withKeepMetaName(java.lang.Boolean keepMetaName)
MultiContextField	withMatchRule(java.util.Collection<MatchRule> __values)
MultiContextField	withMatchRule(MatchRule... __values) List of rules to define which document metas should be mapped to this dynamic property.
MultiContextField	withName(java.lang.String name)
MultiContextField	withType(java.lang.String type)
void	writeTo(java.io.OutputStream os) Write this MultiContextField as an XML fragment

Methods inherited from class com.exalead.search.v30.AbstractRetrievedField

getIndexField, getName, getType, setIndexField, setName, setType

Methods inherited from class java.lang.Object

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

Field Detail

contextName

public java.lang.String contextName

matchRule

public java.util.List<MatchRule> matchRule

keepMetaName

public boolean keepMetaName

DEFAULT_KEEP_META_NAME

public static final boolean DEFAULT_KEEP_META_NAME

See Also:

Constant Field Values

Constructor Detail

MultiContextField

public MultiContextField()

MultiContextField

public MultiContextField(MultiContextField o)

Copy constructor

Method Detail

withIndexField

public MultiContextField withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class AbstractRetrievedField

withName

public MultiContextField withName(java.lang.String name)

Overrides:

withName in class AbstractRetrievedField

withType

public MultiContextField withType(java.lang.String type)

Overrides:

withType in class AbstractRetrievedField

setContextName

public void setContextName(java.lang.String contextName)

getContextName

public java.lang.String getContextName()

withContextName

public MultiContextField withContextName(java.lang.String contextName)

getMatchRule

public java.util.List<MatchRule> getMatchRule()

List of rules to define which document metas should be mapped to this dynamic property.

withMatchRule

public MultiContextField withMatchRule(MatchRule... __values)

List of rules to define which document metas should be mapped to this dynamic property.

withMatchRule

public MultiContextField withMatchRule(java.util.Collection<MatchRule> __values)

setKeepMetaName

public void setKeepMetaName(boolean keepMetaName)

When set to true, a key:value stored in the field will create a meta "key" which value is "value". Otherwise, this will generate a meta "name" which value is "value".

isKeepMetaName

public boolean isKeepMetaName()

When set to true, a key:value stored in the field will create a meta "key" which value is "value". Otherwise, this will generate a meta "name" which value is "value".

withKeepMetaName

public MultiContextField withKeepMetaName(boolean keepMetaName)

withKeepMetaName

public MultiContextField withKeepMetaName(java.lang.Boolean keepMetaName)

makeCopy

public MultiContextField makeCopy()

Creates and returns a deep copy of this MultiContextField.

Overrides:

makeCopy in class AbstractRetrievedField

readFrom

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

Read this MultiContextField 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 MultiContextField as an XML fragment

Overrides:

writeTo in class AbstractRetrievedField

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this MultiContextField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this MultiContextField.

Overrides:

toString in class AbstractRetrievedField

check

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

Checks this MultiContextField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AbstractRetrievedField

Throws:

com.exalead.util.TypedException