com.primus.ae.searchclient
Class StructuredStatement

java.lang.Object
  com.primus.ae.searchclient.StructuredStatement

All Implemented Interfaces:

java.io.Serializable

public class StructuredStatement
extends java.lang.Object
implements java.io.Serializable

Structured statement that will be used in creating structured request

See Also:

Serialized Form

Constructor Summary

StructuredStatement()
default constructor

StructuredStatement(java.lang.String name, java.lang.String queryText)

StructuredStatement(java.lang.String name, java.lang.String queryText, java.lang.String op, java.lang.String mode, java.lang.String strategy, int weight, int threshold, boolean mutex)

Method Summary

java.lang.String	getMode()
boolean	getMutex()
java.lang.String	getName()
java.lang.String	getOp()
java.lang.String	getQueryText()
java.lang.String	getStrategy()
int	getThreshold()
int	getWeight()
void	setMode(java.lang.String mode)
void	setMutex(boolean mutex)
void	setName(java.lang.String name)
void	setOp(java.lang.String op)
void	setQueryText(java.lang.String queryText)
void	setStrategy(java.lang.String strategy)
void	setThreshold(int threshold)
void	setWeight(int weight)
java.lang.String	toXML()

Methods inherited from class java.lang.Object

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

Constructor Detail

StructuredStatement

public StructuredStatement()

default constructor

StructuredStatement

public StructuredStatement(java.lang.String name,
                           java.lang.String queryText)

Parameters:

name - name of the text field

queryText - search input for the named text field

StructuredStatement

public StructuredStatement(java.lang.String name,
                           java.lang.String queryText,
                           java.lang.String op,
                           java.lang.String mode,
                           java.lang.String strategy,
                           int weight,
                           int threshold,
                           boolean mutex)

Parameters:

name - name of the text field

queryText - search input for the named text field

op - mode of aggregating results [required,negative,optional]

mode - query mode [nlp,boolean]

strategy - query strategy [normal,everything,expand,restrict,exact]

weight - weight of query results[0-100]

threshold - minimum score for results [0-100]

mutex - should this statements results be mutually exclusive of other statement results [false,true]

Method Detail

getName

public java.lang.String getName()

Returns:

name name of the text field

getQueryText

public java.lang.String getQueryText()

Returns:

queryText text search input for the named text field

getOp

public java.lang.String getOp()

Returns:

op mode of aggregating results [required,negative,optional]

getMode

public java.lang.String getMode()

Returns:

mode query mode [nlp,boolean]

getStrategy

public java.lang.String getStrategy()

Returns:

strategy query strategy [normal,everything,expand,restrict,exact]

getWeight

public int getWeight()

Returns:

weight weight of query results[0-100]

getThreshold

public int getThreshold()

Returns:

threshold minimum score for results [0-100]

getMutex

public boolean getMutex()

Returns:

mutex should this statements results be mutually exclusive of other statement results [false,true]

setName

public void setName(java.lang.String name)

Parameters:

name - name of the text field

setQueryText

public void setQueryText(java.lang.String queryText)

Parameters:

queryText - text search input for the named text field

setOp

public void setOp(java.lang.String op)

Parameters:

op - mode of aggregating results [required,negative,optional]

setMode

public void setMode(java.lang.String mode)

Parameters:

mode - query mode [nlp,boolean]

setStrategy

public void setStrategy(java.lang.String strategy)

Parameters:

strategy - query strategy [normal,everything,expand,restrict,exact]

setWeight

public void setWeight(int weight)

Parameters:

weight - weight of query results[0-100]

setThreshold

public void setThreshold(int threshold)

Parameters:

threshold - minimum score for results [0-100]

setMutex

public void setMutex(boolean mutex)

Parameters:

mutex - should this statements results be mutually exclusive of other statement results [false,true]

toXML

public java.lang.String toXML()

Returns:

xml form of the statement that can be used in making requests to AE server