de.geeksfactory.opacclient.searchfields

Class SearchField

java.lang.Object

de.geeksfactory.opacclient.searchfields.SearchField

Direct Known Subclasses:

BarcodeSearchField, CheckboxSearchField, DropdownSearchField, TextSearchField

public abstract class SearchField
extends java.lang.Object

A SearchField is the abstract representation of a criteria input available in the search form.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchField.Meaning A SearchField can have one of the following meanings.
static class	SearchField.OrderComparator Sorts search fields by the order of the SearchField.Meaning enum.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	advanced
protected org.json.JSONObject	data A JSONObject where you can save arbitrary data about this Search field.
protected java.lang.String	displayName
protected java.lang.String	id
protected SearchField.Meaning	meaning Optional attribute, describes the meaning of the search field.
protected boolean	visible

Constructor Summary

Constructors

Constructor and Description
SearchField()
SearchField(java.lang.String id, java.lang.String displayName, boolean advanced)

Method Summary

Modifier and Type	Method and Description
static SearchField	fromJSON(org.json.JSONObject json) Initialize a SearchField from its JSON-serialized counterpart
org.json.JSONObject	getData() Get raw additional SearchField data
java.lang.String	getDisplayName() Get the name of this field to be displayed
java.lang.String	getId() Get this field's internal ID
SearchField.Meaning	getMeaning() Returns the SearchField's guessed or specified meaning
boolean	isAdvanced() Get whether this field should only be displayed in "advanced mode".
boolean	isVisible() Get whether this field is visible on the UI
void	setAdvanced(boolean advanced) Set whether this field should only be displayed in "advanced mode".
void	setData(org.json.JSONObject data) Set raw additional SearchField data
void	setDisplayName(java.lang.String displayName) Set the name of this field to be displayed
void	setId(java.lang.String id) Set this field's internal ID
void	setMeaning(SearchField.Meaning meaning) Set the SearchField's meaning
void	setVisible(boolean visible) Set whether this field is visible on the UI
org.json.JSONObject	toJSON() Serialize a SearchField to a JSONObject.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

protected java.lang.String id

displayName

protected java.lang.String displayName

advanced

protected boolean advanced

visible

protected boolean visible

meaning

protected SearchField.Meaning meaning

Optional attribute, describes the meaning of the search field. Used for sorting the search fields in the form. Will be assigned automatically by the MeaningDetector if you use it.

data

protected org.json.JSONObject data

A JSONObject where you can save arbitrary data about this Search field. If you add a "meaning" attribute, MeaningDetector will search for that string in the meanings list instead of the displayName.

Constructor Detail

SearchField

public SearchField()

SearchField

public SearchField(java.lang.String id,
                   java.lang.String displayName,
                   boolean advanced)

Method Detail

fromJSON

public static SearchField fromJSON(org.json.JSONObject json)
                            throws org.json.JSONException

Initialize a SearchField from its JSON-serialized counterpart

Throws:

org.json.JSONException

getId

public java.lang.String getId()

Get this field's internal ID

setId

public void setId(java.lang.String id)

Set this field's internal ID

getDisplayName

public java.lang.String getDisplayName()

Get the name of this field to be displayed

setDisplayName

public void setDisplayName(java.lang.String displayName)

Set the name of this field to be displayed

isAdvanced

public boolean isAdvanced()

Get whether this field should only be displayed in "advanced mode".

setAdvanced

public void setAdvanced(boolean advanced)

Set whether this field should only be displayed in "advanced mode".

isVisible

public boolean isVisible()

Get whether this field is visible on the UI

setVisible

public void setVisible(boolean visible)

Set whether this field is visible on the UI

toJSON

public org.json.JSONObject toJSON()
                           throws org.json.JSONException

Serialize a SearchField to a JSONObject.

Throws:

org.json.JSONException

getData

public org.json.JSONObject getData()

Get raw additional SearchField data

setData

public void setData(org.json.JSONObject data)

Set raw additional SearchField data

getMeaning

public SearchField.Meaning getMeaning()

Returns the SearchField's guessed or specified meaning

setMeaning

public void setMeaning(SearchField.Meaning meaning)

Set the SearchField's meaning

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object