com.orchestranetworks.addon.tese

Class SearchContext

java.lang.Object

com.orchestranetworks.addon.tese.SearchContext

public final class SearchContext
extends Object

Defines the context for the execution of SearchOperations.searchDataset(SearchContext).

Constructor Summary

Constructors

Constructor and Description
SearchContext(com.onwbp.adaptation.Adaptation dataset, Locale locale, List<com.orchestranetworks.schema.SchemaNode> selectedNodes, Date query, BigDecimal searchSensitivity, com.orchestranetworks.service.Session session) Uses this constructor if the Search is called outside a Procedure.
SearchContext(com.onwbp.adaptation.Adaptation dataset, Locale locale, List<com.orchestranetworks.schema.SchemaNode> selectedNodes, String query, BigDecimal searchSensitivity, com.orchestranetworks.service.ProcedureContext procedureContext) Uses this constructor if the Search is called inside a Procedure.
SearchContext(com.onwbp.adaptation.Adaptation dataset, Locale locale, List<com.orchestranetworks.schema.SchemaNode> selectedNodes, String query, BigDecimal searchSensitivity, com.orchestranetworks.service.Session session) Uses this constructor if the Search is called outside a Procedure.

Method Summary

Modifier and Type	Method and Description
com.onwbp.adaptation.Adaptation	getDataset() Gets the dataset used for a search.
Date	getDateQuery() Gets search date.
List<com.orchestranetworks.schema.SchemaNode>	getFieldsSelected() Gets the selected fields when searching on fields.
Locale	getLocale() Gets current locale.
com.orchestranetworks.service.ProcedureContext	getProcedureContext() Gets current procedure context.
String	getQuery() Gets search text.
SearchSelectionMode	getSearchSelectionMode() Gets the current SearchSelectionMode.
BigDecimal	getSearchSensibility() Deprecated. As of release 2.1.0, replaced by getSearchSensitivity()
BigDecimal	getSearchSensitivity() Gets percentage level of the similarity between information and the search criterion.
com.orchestranetworks.service.Session	getSession() Gets current user session.
List<com.orchestranetworks.schema.SchemaNode>	getTablesSelected() Gets the tables used for a search.
boolean	isPermissionChecked() Checks user's permission to access data.
boolean	isPersistedResult() Deprecated. as of release 2.0.0.
boolean	isSearchDate() Returns true when the search is on a date/time data type.
void	setPermissionChecked(boolean permissionChecked) Checks user's permission to access data.
void	setPersistedResult(boolean persistedResult) Deprecated. as of release 2.0.0.
void	setSearchSelectionMode(SearchSelectionMode searchMode) Sets the SearchSelectionMode for a search.
void	setXPathFilter(String predicate) Allows you to define an xpath predicate filter in order to reduce the search scope.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchContext

public SearchContext(com.onwbp.adaptation.Adaptation dataset,
                     Locale locale,
                     List<com.orchestranetworks.schema.SchemaNode> selectedNodes,
                     String query,
                     BigDecimal searchSensitivity,
                     com.orchestranetworks.service.Session session)

Uses this constructor if the Search is called outside a Procedure. Default SearchSelectionMode is SearchSelectionMode.TABLE.

SearchContext

public SearchContext(com.onwbp.adaptation.Adaptation dataset,
                     Locale locale,
                     List<com.orchestranetworks.schema.SchemaNode> selectedNodes,
                     Date query,
                     BigDecimal searchSensitivity,
                     com.orchestranetworks.service.Session session)

Uses this constructor if the Search is called outside a Procedure. Default SearchSelectionMode is SearchSelectionMode.TABLE.

Since:

1.6.0

SearchContext

public SearchContext(com.onwbp.adaptation.Adaptation dataset,
                     Locale locale,
                     List<com.orchestranetworks.schema.SchemaNode> selectedNodes,
                     String query,
                     BigDecimal searchSensitivity,
                     com.orchestranetworks.service.ProcedureContext procedureContext)

Uses this constructor if the Search is called inside a Procedure. Default SearchSelectionMode is SearchSelectionMode.TABLE.

Method Detail

isPersistedResult

public boolean isPersistedResult()

Deprecated. as of release 2.0.0.

Returns true if the result is persisted.

Since:

1.5.0

setPersistedResult

public void setPersistedResult(boolean persistedResult)

Deprecated. as of release 2.0.0.

Sets the persistence mode of the results. Defaults to true. If set to false, the results are not persisted.

Since:

1.5.0

setXPathFilter

public void setXPathFilter(String predicate)

Allows you to define an xpath predicate filter in order to reduce the search scope.

getDataset

public com.onwbp.adaptation.Adaptation getDataset()

Gets the dataset used for a search.

getLocale

public Locale getLocale()

Gets current locale.

getTablesSelected

public List<com.orchestranetworks.schema.SchemaNode> getTablesSelected()

Gets the tables used for a search.

getQuery

public String getQuery()

Gets search text.

getDateQuery

public Date getDateQuery()

Gets search date.

Since:

1.6.0

getSearchSensitivity

public BigDecimal getSearchSensitivity()

Gets percentage level of the similarity between information and the search criterion.

getSearchSensibility

public BigDecimal getSearchSensibility()

Deprecated. As of release 2.1.0, replaced by getSearchSensitivity()

Gets percentage level of the similarity between information and the search criterion.

getSession

public com.orchestranetworks.service.Session getSession()

Gets current user session.

getProcedureContext

public com.orchestranetworks.service.ProcedureContext getProcedureContext()

Gets current procedure context.

Since:

1.3.1

isSearchDate

public boolean isSearchDate()

Returns true when the search is on a date/time data type.

Since:

1.6.0

isPermissionChecked

public boolean isPermissionChecked()

Checks user's permission to access data.

Since:

1.5.4

setPermissionChecked

public void setPermissionChecked(boolean permissionChecked)

Checks user's permission to access data.

Since:

1.5.4

getFieldsSelected

public List<com.orchestranetworks.schema.SchemaNode> getFieldsSelected()

Gets the selected fields when searching on fields.

Since:

1.7.0

setSearchSelectionMode

public void setSearchSelectionMode(SearchSelectionMode searchMode)

Sets the SearchSelectionMode for a search.

Since:

1.7.0

getSearchSelectionMode

public SearchSelectionMode getSearchSelectionMode()

Gets the current SearchSelectionMode.

Since:

1.7.0