com.exalead.indexing.analysis.v10

Class FieldIndexingLimit

java.lang.Object

com.exalead.indexing.analysis.v10.FieldIndexingLimit

All Implemented Interfaces:

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

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

Limits the number of words that can be retrieved from a given field.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	fieldName
int	maxNbWords

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this FieldIndexingLimit.
static FieldIndexingLimit	fromString(java.lang.String s) String representation of this FieldIndexingLimit.
java.lang.String	getFieldName() Field to limit.
int	getMaxNbWords() Maximum number of words for this field.
FieldIndexingLimit	makeCopy() Creates and returns a deep copy of this FieldIndexingLimit.
static FieldIndexingLimit	readFrom(java.io.InputStream is) Read this FieldIndexingLimit from an XML fragment.
void	setFieldName(java.lang.String fieldName) Field to limit.
void	setMaxNbWords(int maxNbWords) Maximum number of words for this field.
java.lang.String	toString() String representation of this FieldIndexingLimit.
FieldIndexingLimit	withFieldName(java.lang.String fieldName)
FieldIndexingLimit	withMaxNbWords(int maxNbWords)
FieldIndexingLimit	withMaxNbWords(java.lang.Integer maxNbWords)
void	writeTo(java.io.OutputStream os) Write this FieldIndexingLimit as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

fieldName

public java.lang.String fieldName

maxNbWords

public int maxNbWords

Constructor Detail

FieldIndexingLimit

public FieldIndexingLimit()

FieldIndexingLimit

public FieldIndexingLimit(FieldIndexingLimit o)

Copy constructor

Method Detail

setFieldName

public void setFieldName(java.lang.String fieldName)

Field to limit.

getFieldName

public java.lang.String getFieldName()

Field to limit.

withFieldName

public FieldIndexingLimit withFieldName(java.lang.String fieldName)

setMaxNbWords

public void setMaxNbWords(int maxNbWords)

Maximum number of words for this field.

getMaxNbWords

public int getMaxNbWords()

Maximum number of words for this field.

withMaxNbWords

public FieldIndexingLimit withMaxNbWords(int maxNbWords)

withMaxNbWords

public FieldIndexingLimit withMaxNbWords(java.lang.Integer maxNbWords)

makeCopy

public FieldIndexingLimit makeCopy()

Creates and returns a deep copy of this FieldIndexingLimit.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FieldIndexingLimit.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FieldIndexingLimit.

Overrides:

toString in class java.lang.Object

check

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

Checks this FieldIndexingLimit.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException