com.exalead.search.v30

Class DynamicFieldElementSource

java.lang.Object

com.exalead.search.v30.MetaSource

com.exalead.search.v30.DynamicFieldElementSource

All Implemented Interfaces:

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

public class DynamicFieldElementSource
extends MetaSource
implements com.exalead.util.Checkable, java.io.Serializable

Specifies from which index dynamic field the meta will be retrieved.

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this DynamicFieldElementSource.
static DynamicFieldElementSource	fromString(java.lang.String s) String representation of this DynamicFieldElementSource.
java.lang.String	getIndexField() Dynamic index field for this meta source.
java.util.List<MatchRule>	getMatchRule() List of rules to define which metas contained in this dynamic field will be processed and displayed.
java.lang.String	getName() Specifies the meta name used to retrieve the value in the Dynamic Index Field. If null, it retrieves all meta/value pairs.
boolean	isKeepMetaName() When set to true, a key:value stored in the field will create a meta "key" which value is "value".
DynamicFieldElementSource	makeCopy() Creates and returns a deep copy of this DynamicFieldElementSource.
static DynamicFieldElementSource	readFrom(java.io.InputStream is) Read this DynamicFieldElementSource from an XML fragment.
void	setIndexField(java.lang.String indexField) Dynamic index field for this meta source.
void	setKeepMetaName(boolean keepMetaName) When set to true, a key:value stored in the field will create a meta "key" which value is "value".
void	setName(java.lang.String name) Specifies the meta name used to retrieve the value in the Dynamic Index Field. If null, it retrieves all meta/value pairs.
java.lang.String	toString() String representation of this DynamicFieldElementSource.
DynamicFieldElementSource	withIndexField(java.lang.String indexField)
DynamicFieldElementSource	withKeepMetaName(boolean keepMetaName)
DynamicFieldElementSource	withKeepMetaName(java.lang.Boolean keepMetaName)
DynamicFieldElementSource	withMatchRule(java.util.Collection<MatchRule> __values)
DynamicFieldElementSource	withMatchRule(MatchRule... __values) List of rules to define which metas contained in this dynamic field will be processed and displayed.
DynamicFieldElementSource	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this DynamicFieldElementSource as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

indexField

public java.lang.String indexField

name

public java.lang.String name

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

DynamicFieldElementSource

public DynamicFieldElementSource()

DynamicFieldElementSource

public DynamicFieldElementSource(DynamicFieldElementSource o)

Copy constructor

Method Detail

setIndexField

public void setIndexField(java.lang.String indexField)

Dynamic index field for this meta source.

getIndexField

public java.lang.String getIndexField()

Dynamic index field for this meta source.

withIndexField

public DynamicFieldElementSource withIndexField(java.lang.String indexField)

setName

public void setName(java.lang.String name)

Specifies the meta name used to retrieve the value in the Dynamic Index Field.
If null, it retrieves all meta/value pairs.

getName

public java.lang.String getName()

Specifies the meta name used to retrieve the value in the Dynamic Index Field.
If null, it retrieves all meta/value pairs.

withName

public DynamicFieldElementSource withName(java.lang.String name)

getMatchRule

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

List of rules to define which metas contained in this dynamic field will be processed and displayed.

withMatchRule

public DynamicFieldElementSource withMatchRule(MatchRule... __values)

List of rules to define which metas contained in this dynamic field will be processed and displayed.

withMatchRule

public DynamicFieldElementSource 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 DynamicFieldElementSource withKeepMetaName(boolean keepMetaName)

withKeepMetaName

public DynamicFieldElementSource withKeepMetaName(java.lang.Boolean keepMetaName)

makeCopy

public DynamicFieldElementSource makeCopy()

Creates and returns a deep copy of this DynamicFieldElementSource.

Overrides:

makeCopy in class MetaSource

readFrom

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

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

Overrides:

writeTo in class MetaSource

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DynamicFieldElementSource.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DynamicFieldElementSource.

Overrides:

toString in class MetaSource

check

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

Checks this DynamicFieldElementSource.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class MetaSource

Throws:

com.exalead.util.TypedException