com.exalead.search.v30

Class ProximityBoostConfig

java.lang.Object

com.exalead.search.v30.ProximityBoostConfig

All Implemented Interfaces:

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

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

Controls the behavior of the @proximity element

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED
static int	DEFAULT_MAX_DISTANCE
boolean	enabled
int	maxDistance

Constructor Summary

Constructors

Constructor and Description
ProximityBoostConfig()
ProximityBoostConfig(boolean enabled, int maxDistance)
ProximityBoostConfig(ProximityBoostConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ProximityBoostConfig.
static ProximityBoostConfig	fromString(java.lang.String s) String representation of this ProximityBoostConfig.
int	getMaxDistance() Do not apply proximity boost if words are separated by more than 'maxDistance' words.
boolean	isEnabled() Enables proximity calculation globally.
ProximityBoostConfig	makeCopy() Creates and returns a deep copy of this ProximityBoostConfig.
static ProximityBoostConfig	readFrom(java.io.InputStream is) Read this ProximityBoostConfig from an XML fragment.
void	setEnabled(boolean enabled) Enables proximity calculation globally.
void	setMaxDistance(int maxDistance) Do not apply proximity boost if words are separated by more than 'maxDistance' words.
java.lang.String	toString() String representation of this ProximityBoostConfig.
ProximityBoostConfig	withEnabled(boolean enabled)
ProximityBoostConfig	withEnabled(java.lang.Boolean enabled)
ProximityBoostConfig	withMaxDistance(int maxDistance)
ProximityBoostConfig	withMaxDistance(java.lang.Integer maxDistance)
void	writeTo(java.io.OutputStream os) Write this ProximityBoostConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

enabled

public boolean enabled

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

Constant Field Values

maxDistance

public int maxDistance

DEFAULT_MAX_DISTANCE

public static final int DEFAULT_MAX_DISTANCE

See Also:

Constant Field Values

Constructor Detail

ProximityBoostConfig

public ProximityBoostConfig()

ProximityBoostConfig

public ProximityBoostConfig(boolean enabled,
                            int maxDistance)

ProximityBoostConfig

public ProximityBoostConfig(ProximityBoostConfig o)

Copy constructor

Method Detail

setEnabled

public void setEnabled(boolean enabled)

Enables proximity calculation globally. When disabled, @proximity is always 1.0

isEnabled

public boolean isEnabled()

Enables proximity calculation globally. When disabled, @proximity is always 1.0

withEnabled

public ProximityBoostConfig withEnabled(boolean enabled)

withEnabled

public ProximityBoostConfig withEnabled(java.lang.Boolean enabled)

setMaxDistance

public void setMaxDistance(int maxDistance)

Do not apply proximity boost if words are separated by more than 'maxDistance' words.

getMaxDistance

public int getMaxDistance()

Do not apply proximity boost if words are separated by more than 'maxDistance' words.

withMaxDistance

public ProximityBoostConfig withMaxDistance(int maxDistance)

withMaxDistance

public ProximityBoostConfig withMaxDistance(java.lang.Integer maxDistance)

makeCopy

public ProximityBoostConfig makeCopy()

Creates and returns a deep copy of this ProximityBoostConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ProximityBoostConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ProximityBoostConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this ProximityBoostConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException