com.exalead.search.v30

Class RetrievedField

java.lang.Object

com.exalead.search.v30.AbstractRetrievedField

com.exalead.search.v30.RetrievedField

All Implemented Interfaces:

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

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

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RetrievedField.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	dataModelClass
java.lang.String	dataModelProperty
java.lang.String	dataModelState
static boolean	DEFAULT_MULTIVALUED
protected RetrievedField.FromDataModel	fromDataModel
boolean	multivalued

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

indexField, name, type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this RetrievedField.
static RetrievedField	fromString(java.lang.String s) String representation of this RetrievedField.
java.lang.String	getDataModelClass() If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this RetrievedField.
java.lang.String	getDataModelProperty() If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this RetrievedField.
java.lang.String	getDataModelState() Is this retrieved field managed by a data model?
RetrievedField.FromDataModel	getFromDataModel()
boolean	isMultivalued() Is the field to retrieve multivalued? FIXME
RetrievedField	makeCopy() Creates and returns a deep copy of this RetrievedField.
static RetrievedField	readFrom(java.io.InputStream is) Read this RetrievedField from an XML fragment.
void	setDataModelClass(java.lang.String dataModelClass) If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this RetrievedField.
void	setDataModelProperty(java.lang.String dataModelProperty) If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this RetrievedField.
void	setDataModelState(java.lang.String dataModelState) Is this retrieved field managed by a data model?
void	setFromDataModel(RetrievedField.FromDataModel __value)
void	setMultivalued(boolean multivalued) Is the field to retrieve multivalued? FIXME
java.lang.String	toString() String representation of this RetrievedField.
RetrievedField	withDataModelClass(java.lang.String dataModelClass)
RetrievedField	withDataModelProperty(java.lang.String dataModelProperty)
RetrievedField	withDataModelState(java.lang.String dataModelState)
RetrievedField	withIndexField(java.lang.String indexField)
RetrievedField	withMultivalued(boolean multivalued)
RetrievedField	withMultivalued(java.lang.Boolean multivalued)
RetrievedField	withName(java.lang.String name)
RetrievedField	withType(java.lang.String type)
void	writeTo(java.io.OutputStream os) Write this RetrievedField 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

multivalued

public boolean multivalued

DEFAULT_MULTIVALUED

public static final boolean DEFAULT_MULTIVALUED

See Also:

Constant Field Values

dataModelState

public java.lang.String dataModelState

fromDataModel

protected RetrievedField.FromDataModel fromDataModel

dataModelClass

public java.lang.String dataModelClass

dataModelProperty

public java.lang.String dataModelProperty

Constructor Detail

RetrievedField

public RetrievedField()

RetrievedField

public RetrievedField(RetrievedField o)

Copy constructor

Method Detail

withIndexField

public RetrievedField withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class AbstractRetrievedField

withName

public RetrievedField withName(java.lang.String name)

Overrides:

withName in class AbstractRetrievedField

withType

public RetrievedField withType(java.lang.String type)

Overrides:

withType in class AbstractRetrievedField

setMultivalued

public void setMultivalued(boolean multivalued)

Is the field to retrieve multivalued? FIXME

isMultivalued

public boolean isMultivalued()

Is the field to retrieve multivalued? FIXME

withMultivalued

public RetrievedField withMultivalued(boolean multivalued)

withMultivalued

public RetrievedField withMultivalued(java.lang.Boolean multivalued)

setDataModelState

public void setDataModelState(java.lang.String dataModelState)

Is this retrieved field managed by a data model?

getDataModelState

public java.lang.String getDataModelState()

Is this retrieved field managed by a data model?

withDataModelState

public RetrievedField withDataModelState(java.lang.String dataModelState)

getFromDataModel

public RetrievedField.FromDataModel getFromDataModel()

setFromDataModel

public void setFromDataModel(RetrievedField.FromDataModel __value)

setDataModelClass

public void setDataModelClass(java.lang.String dataModelClass)

If dataModelState is "auto" or "customized", you will find here the
name of the DataModelClass that generated this RetrievedField.

getDataModelClass

public java.lang.String getDataModelClass()

If dataModelState is "auto" or "customized", you will find here the
name of the DataModelClass that generated this RetrievedField.

withDataModelClass

public RetrievedField withDataModelClass(java.lang.String dataModelClass)

setDataModelProperty

public void setDataModelProperty(java.lang.String dataModelProperty)

If dataModelState is "auto" or "customized", you will find here the
name of the DataModelProperty that generated this RetrievedField.

getDataModelProperty

public java.lang.String getDataModelProperty()

If dataModelState is "auto" or "customized", you will find here the
name of the DataModelProperty that generated this RetrievedField.

withDataModelProperty

public RetrievedField withDataModelProperty(java.lang.String dataModelProperty)

makeCopy

public RetrievedField makeCopy()

Creates and returns a deep copy of this RetrievedField.

Overrides:

makeCopy in class AbstractRetrievedField

readFrom

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

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

Overrides:

writeTo in class AbstractRetrievedField

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RetrievedField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RetrievedField.

Overrides:

toString in class AbstractRetrievedField

check

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

Checks this RetrievedField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AbstractRetrievedField

Throws:

com.exalead.util.TypedException