com.exalead.search.v30

Class HitConfig

java.lang.Object

com.exalead.search.v30.HitConfig

All Implemented Interfaces:

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

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

No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
AdvancedPipeline	advancedPipeline
DataModelClassMetaInformation	dataModelClassMetaInformation
static int	DEFAULT_FULL_HITS
int	fullHits
java.util.List<Meta>	meta
java.util.List<Metas>	metas

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this HitConfig.
static HitConfig	fromString(java.lang.String s) String representation of this HitConfig.
AdvancedPipeline	getAdvancedPipeline()
DataModelClassMetaInformation	getDataModelClassMetaInformation()
int	getFullHits() Number of full hits to retrieve per page. -1 means unlimited.
java.util.List<Meta>	getMeta()
java.util.Map<java.lang.String,Meta>	getMetaAsMap() Get the map of Meta, indexed by name
Meta	getMetaByName(java.lang.String _lookup) Get the Meta for which the name matches _lookup
java.util.List<Metas>	getMetas()
HitConfig	makeCopy() Creates and returns a deep copy of this HitConfig.
static HitConfig	readFrom(java.io.InputStream is) Read this HitConfig from an XML fragment.
boolean	removeMetaByName(java.lang.String _lookup) Removes the Meta for which the name matches _lookup
void	setAdvancedPipeline(AdvancedPipeline advancedPipeline)
void	setDataModelClassMetaInformation(DataModelClassMetaInformation dataModelClassMetaInformation)
void	setFullHits(int fullHits) Number of full hits to retrieve per page. -1 means unlimited.
java.lang.String	toString() String representation of this HitConfig.
HitConfig	withAdvancedPipeline(AdvancedPipeline advancedPipeline)
HitConfig	withDataModelClassMetaInformation(DataModelClassMetaInformation dataModelClassMetaInformation)
HitConfig	withFullHits(int fullHits)
HitConfig	withFullHits(java.lang.Integer fullHits)
HitConfig	withMeta(java.util.Collection<Meta> __values)
HitConfig	withMeta(Meta... __values)
HitConfig	withMetas(java.util.Collection<Metas> __values)
HitConfig	withMetas(Metas... __values)
void	writeTo(java.io.OutputStream os) Write this HitConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

meta

public java.util.List<Meta> meta

metas

public java.util.List<Metas> metas

advancedPipeline

public AdvancedPipeline advancedPipeline

dataModelClassMetaInformation

public DataModelClassMetaInformation dataModelClassMetaInformation

fullHits

public int fullHits

DEFAULT_FULL_HITS

public static final int DEFAULT_FULL_HITS

See Also:

Constant Field Values

Constructor Detail

HitConfig

public HitConfig()

HitConfig

public HitConfig(HitConfig o)

Copy constructor

Method Detail

getMeta

public java.util.List<Meta> getMeta()

getMetaByName

public Meta getMetaByName(java.lang.String _lookup)

Get the Meta for which the name matches _lookup

Returns:

null if no matching Meta is found

getMetaAsMap

public java.util.Map<java.lang.String,Meta> getMetaAsMap()

Get the map of Meta, indexed by name

removeMetaByName

public boolean removeMetaByName(java.lang.String _lookup)

Removes the Meta for which the name matches _lookup

Returns:

false if no matching Meta is found, true if one was found

withMeta

public HitConfig withMeta(Meta... __values)

withMeta

public HitConfig withMeta(java.util.Collection<Meta> __values)

getMetas

public java.util.List<Metas> getMetas()

withMetas

public HitConfig withMetas(Metas... __values)

withMetas

public HitConfig withMetas(java.util.Collection<Metas> __values)

setAdvancedPipeline

public void setAdvancedPipeline(AdvancedPipeline advancedPipeline)

getAdvancedPipeline

public AdvancedPipeline getAdvancedPipeline()

withAdvancedPipeline

public HitConfig withAdvancedPipeline(AdvancedPipeline advancedPipeline)

setDataModelClassMetaInformation

public void setDataModelClassMetaInformation(DataModelClassMetaInformation dataModelClassMetaInformation)

getDataModelClassMetaInformation

public DataModelClassMetaInformation getDataModelClassMetaInformation()

withDataModelClassMetaInformation

public HitConfig withDataModelClassMetaInformation(DataModelClassMetaInformation dataModelClassMetaInformation)

setFullHits

public void setFullHits(int fullHits)

Number of full hits to retrieve per page.
-1 means unlimited.

getFullHits

public int getFullHits()

Number of full hits to retrieve per page.
-1 means unlimited.

withFullHits

public HitConfig withFullHits(int fullHits)

withFullHits

public HitConfig withFullHits(java.lang.Integer fullHits)

makeCopy

public HitConfig makeCopy()

Creates and returns a deep copy of this HitConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this HitConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this HitConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this HitConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException