com.browseengine.bobo.api
Class BrowseSelection

java.lang.Object
  com.browseengine.bobo.api.BrowseSelection

All Implemented Interfaces:

Serializable

public class BrowseSelection
extends Object
implements Serializable

Browse selection.

See Also:

Serialized Form

Nested Class Summary

static class

BrowseSelection.ValueOperation Sets how selections filter given multiple of selections within one field

Field Summary

protected ArrayList<String>	notValues
protected ArrayList<String>	values

Constructor Summary

BrowseSelection(String fieldName)
Constructor

Method Summary

BrowseSelection	addNotValue(String val) Add a select NOT value
BrowseSelection	addValue(String val) Add a select value
int	getDepth() Deprecated. use getSelectionProperties()
String	getFieldName() Gets the field name
String[]	getNotValues() Gets the selected NOT values
BrowseSelection.ValueOperation	getSelectionOperation() Gets value operation.
Properties	getSelectionProperties()
String[]	getValues() Gets the selected values
boolean	isStrict() Deprecated. use getSelectionProperties()
BrowseSelection	setDepth(int depth) Deprecated. use getSelectionProperties()
BrowseSelection	setNotValues(String[] notVals) Sets the NOT values
BrowseSelection	setSelectionOperation(BrowseSelection.ValueOperation selectionOperation) Sets value operation
void	setSelectionProperties(Map<String,String> props)
void	setSelectionProperty(String key, String val)
BrowseSelection	setStrict(boolean strict) Deprecated. use setSelectionOperation(ValueOperation)
BrowseSelection	setValues(String[] vals) Sets the selected values
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

values

protected ArrayList<String> values

notValues

protected ArrayList<String> notValues

Constructor Detail

BrowseSelection

public BrowseSelection(String fieldName)

Constructor

Parameters:

fieldName - field name

Method Detail

setSelectionProperty

public void setSelectionProperty(String key,
                                 String val)

setSelectionProperties

public void setSelectionProperties(Map<String,String> props)

isStrict

public boolean isStrict()

Deprecated. use getSelectionProperties()

Gets if strict applied for counting. Used if the field is of type path.

Returns:

is strict applied

See Also:

setStrict(boolean)

setStrict

public BrowseSelection setStrict(boolean strict)

Deprecated. use setSelectionOperation(ValueOperation)

Sets is strict applied for counting. Used if the field is of type path.

Parameters:

strict - is strict applied

See Also:

isStrict()

getDepth

public int getDepth()

Deprecated. use getSelectionProperties()

Gets the depth. Used if the field is of type path.

Returns:

depth

See Also:

setDepth(int)

setDepth

public BrowseSelection setDepth(int depth)

Deprecated. use getSelectionProperties()

Sets the depth. Used if the field is of type path.

Parameters:

depth - depth

See Also:

getDepth()

getFieldName

public String getFieldName()

Gets the field name

Returns:

field name

getValues

public String[] getValues()

Gets the selected values

Returns:

selected values

See Also:

setValues(String[])

getNotValues

public String[] getNotValues()

Gets the selected NOT values

Returns:

selected NOT values

setValues

public BrowseSelection setValues(String[] vals)

Sets the selected values

Parameters:

vals - selected values

See Also:

getValues()

addValue

public BrowseSelection addValue(String val)

Add a select value

Parameters:

val - select value

addNotValue

public BrowseSelection addNotValue(String val)

Add a select NOT value

Parameters:

val - select NOT value

setNotValues

public BrowseSelection setNotValues(String[] notVals)

Sets the NOT values

Parameters:

notVals - NOT values

getSelectionProperties

public Properties getSelectionProperties()

getSelectionOperation

public BrowseSelection.ValueOperation getSelectionOperation()

Gets value operation.

Returns:

value operation

See Also:

setSelectionOperation(ValueOperation)

setSelectionOperation

public BrowseSelection setSelectionOperation(BrowseSelection.ValueOperation selectionOperation)

Sets value operation

Parameters:

selectionOperation - value operation

See Also:

getSelectionOperation()

toString

public String toString()

Overrides:

toString in class Object