com.exalead.search.v30

Class FieldSource

java.lang.Object

com.exalead.search.v30.MetaSource

com.exalead.search.v30.FieldSource

All Implemented Interfaces:

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

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

Specify from which index field the meta will be retrieved.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	indexField

Constructor Summary

Constructors

Constructor and Description
FieldSource()
FieldSource(FieldSource o) Copy constructor
FieldSource(java.lang.String indexField)

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this FieldSource.
static FieldSource	fromString(java.lang.String s) String representation of this FieldSource.
java.lang.String	getIndexField() Index field, Virtual field or Virtual Expression for this meta source.
FieldSource	makeCopy() Creates and returns a deep copy of this FieldSource.
static FieldSource	readFrom(java.io.InputStream is) Read this FieldSource from an XML fragment.
void	setIndexField(java.lang.String indexField) Index field, Virtual field or Virtual Expression for this meta source.
java.lang.String	toString() String representation of this FieldSource.
FieldSource	withIndexField(java.lang.String indexField)
void	writeTo(java.io.OutputStream os) Write this FieldSource 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

Constructor Detail

FieldSource

public FieldSource()

FieldSource

public FieldSource(java.lang.String indexField)

FieldSource

public FieldSource(FieldSource o)

Copy constructor

Method Detail

setIndexField

public void setIndexField(java.lang.String indexField)

Index field, Virtual field or Virtual Expression for this meta source.

getIndexField

public java.lang.String getIndexField()

Index field, Virtual field or Virtual Expression for this meta source.

withIndexField

public FieldSource withIndexField(java.lang.String indexField)

makeCopy

public FieldSource makeCopy()

Creates and returns a deep copy of this FieldSource.

Overrides:

makeCopy in class MetaSource

readFrom

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

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

Overrides:

writeTo in class MetaSource

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FieldSource.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FieldSource.

Overrides:

toString in class MetaSource

check

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

Checks this FieldSource.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class MetaSource

Throws:

com.exalead.util.TypedException