com.exalead.indexing.analysis.v10

Class FieldRetrievalLimit

java.lang.Object

com.exalead.indexing.analysis.v10.FieldRetrievalLimit

All Implemented Interfaces:

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

public class FieldRetrievalLimit
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Limits the size of text that can be retrieved from a given field.
In some standard configuration, a FieldRetrievalLimit on the 'text' field is set to "maxLength=4096".
This limits the size of the index on disk.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	maxLength
java.lang.String	retrieveField

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this FieldRetrievalLimit.
static FieldRetrievalLimit	fromString(java.lang.String s) String representation of this FieldRetrievalLimit.
int	getMaxLength() Max text size in bytes.
java.lang.String	getRetrieveField() Field to limit.
FieldRetrievalLimit	makeCopy() Creates and returns a deep copy of this FieldRetrievalLimit.
static FieldRetrievalLimit	readFrom(java.io.InputStream is) Read this FieldRetrievalLimit from an XML fragment.
void	setMaxLength(int maxLength) Max text size in bytes.
void	setRetrieveField(java.lang.String retrieveField) Field to limit.
java.lang.String	toString() String representation of this FieldRetrievalLimit.
FieldRetrievalLimit	withMaxLength(int maxLength)
FieldRetrievalLimit	withMaxLength(java.lang.Integer maxLength)
FieldRetrievalLimit	withRetrieveField(java.lang.String retrieveField)
void	writeTo(java.io.OutputStream os) Write this FieldRetrievalLimit as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

retrieveField

public java.lang.String retrieveField

maxLength

public int maxLength

Constructor Detail

FieldRetrievalLimit

public FieldRetrievalLimit()

FieldRetrievalLimit

public FieldRetrievalLimit(FieldRetrievalLimit o)

Copy constructor

Method Detail

setRetrieveField

public void setRetrieveField(java.lang.String retrieveField)

Field to limit.

getRetrieveField

public java.lang.String getRetrieveField()

Field to limit.

withRetrieveField

public FieldRetrievalLimit withRetrieveField(java.lang.String retrieveField)

setMaxLength

public void setMaxLength(int maxLength)

Max text size in bytes.
The text will be clipped to the nearest word.
Text is stored in UTF-8.

getMaxLength

public int getMaxLength()

Max text size in bytes.
The text will be clipped to the nearest word.
Text is stored in UTF-8.

withMaxLength

public FieldRetrievalLimit withMaxLength(int maxLength)

withMaxLength

public FieldRetrievalLimit withMaxLength(java.lang.Integer maxLength)

makeCopy

public FieldRetrievalLimit makeCopy()

Creates and returns a deep copy of this FieldRetrievalLimit.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FieldRetrievalLimit.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FieldRetrievalLimit.

Overrides:

toString in class java.lang.Object

check

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

Checks this FieldRetrievalLimit.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException