com.exalead.search.v30

Class ContentGroupLimitsConfig

java.lang.Object

com.exalead.search.v30.ContentGroupLimitsConfig

All Implemented Interfaces:

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

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

Specific search limits for a content group. May override global limits.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	contentGroup
int	maxHitsPerSlice

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ContentGroupLimitsConfig.
static ContentGroupLimitsConfig	fromString(java.lang.String s) String representation of this ContentGroupLimitsConfig.
java.lang.String	getContentGroup() Name of the content group.
int	getMaxHitsPerSlice() On each slice, when this number of hits matching the query have been found, the query is interrupted.
ContentGroupLimitsConfig	makeCopy() Creates and returns a deep copy of this ContentGroupLimitsConfig.
static ContentGroupLimitsConfig	readFrom(java.io.InputStream is) Read this ContentGroupLimitsConfig from an XML fragment.
void	setContentGroup(java.lang.String contentGroup) Name of the content group.
void	setMaxHitsPerSlice(int maxHitsPerSlice) On each slice, when this number of hits matching the query have been found, the query is interrupted.
java.lang.String	toString() String representation of this ContentGroupLimitsConfig.
ContentGroupLimitsConfig	withContentGroup(java.lang.String contentGroup)
ContentGroupLimitsConfig	withMaxHitsPerSlice(int maxHitsPerSlice)
ContentGroupLimitsConfig	withMaxHitsPerSlice(java.lang.Integer maxHitsPerSlice)
void	writeTo(java.io.OutputStream os) Write this ContentGroupLimitsConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

contentGroup

public java.lang.String contentGroup

maxHitsPerSlice

public int maxHitsPerSlice

Constructor Detail

ContentGroupLimitsConfig

public ContentGroupLimitsConfig()

ContentGroupLimitsConfig

public ContentGroupLimitsConfig(ContentGroupLimitsConfig o)

Copy constructor

Method Detail

setContentGroup

public void setContentGroup(java.lang.String contentGroup)

Name of the content group.

getContentGroup

public java.lang.String getContentGroup()

Name of the content group.

withContentGroup

public ContentGroupLimitsConfig withContentGroup(java.lang.String contentGroup)

setMaxHitsPerSlice

public void setMaxHitsPerSlice(int maxHitsPerSlice)

On each slice, when this number of hits matching the query have been found, the query is interrupted.

These hits are returned to the searcher, ranked, and the "best" ones are selected for navigation and full hits. Reducing this parameter improves performance but it means that a potentially "better" hit located further in the slice would not be found. If this limit triggers on any slice, the "nmatches" value in answer will be estimated.

0 means no limit.

getMaxHitsPerSlice

public int getMaxHitsPerSlice()

On each slice, when this number of hits matching the query have been found, the query is interrupted.

These hits are returned to the searcher, ranked, and the "best" ones are selected for navigation and full hits. Reducing this parameter improves performance but it means that a potentially "better" hit located further in the slice would not be found. If this limit triggers on any slice, the "nmatches" value in answer will be estimated.

0 means no limit.

withMaxHitsPerSlice

public ContentGroupLimitsConfig withMaxHitsPerSlice(int maxHitsPerSlice)

withMaxHitsPerSlice

public ContentGroupLimitsConfig withMaxHitsPerSlice(java.lang.Integer maxHitsPerSlice)

makeCopy

public ContentGroupLimitsConfig makeCopy()

Creates and returns a deep copy of this ContentGroupLimitsConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ContentGroupLimitsConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ContentGroupLimitsConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this ContentGroupLimitsConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException