com.brightech.mb.workflow.js.search

Class SearchWrapper

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.search.SearchWrapper

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable, org.mozilla.javascript.SymbolScriptable, org.mozilla.javascript.Wrapper

public class SearchWrapper
extends JSBaseScriptableObject
implements org.mozilla.javascript.Wrapper

Class to expose Search functionality to workflow-side javascript. Has 3 main components: a SearchVO, a Location, and a list of Criteria.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.mozilla.javascript.ScriptableObject

org.mozilla.javascript.ScriptableObject.KeyComparator

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
SearchWrapper() Zero-arg constructor.

Method Summary

Modifier and Type	Method and Description
void	jsConstructor()
void	jsFunction_createQuickSearch(java.lang.String theSearch, JSSearchPreferences thePreferences) Deprecated.
void	jsFunction_execute(org.mozilla.javascript.Function theCallback, int thePageNumber, int thePageSize) Execute this search, running the supplied callback after execution completes.
ManagedFile[]	jsFunction_executeForArray(int thePageNumber, int thePageSize) Execute this search
CriteriaWrapper	jsFunction_getCriteria() Get the current criteria for this search.
java.lang.String	jsFunction_getDescription() Get the search description
FacetListWrapper	jsFunction_getFacets(SolrConfigWrapper theSolrConfig) Get facets for a particular search.
int	jsFunction_getID() Get the search ID
boolean	jsFunction_getIgnoreAcl() Returns true if the search will ignore the ACL and any mandatory search there
java.lang.String	jsFunction_getMetricsGraph(java.lang.String theSparklineField, java.lang.String theLabel) Execute this search, returning the JSON of the metrics graph.
java.lang.String	jsFunction_getName() Get the name of the search
int	jsFunction_getSearchCount() Get the number of results from this search
java.lang.String	jsFunction_getSearchString() Returns the search engine search string for this search.
java.lang.String	jsFunction_getSortDirection() Get this search object's sort order.
java.lang.String	jsFunction_getSortField() Get this search object's sort field.
FacetWrapper	jsFunction_getTermsWithLimit(SolrConfigWrapper theSolrConfig, int thePageNumber, int thePageSize) Gets terms (with count of number of assets containing the given term) for a given metadata field.
boolean	jsFunction_isPublic() Get if the search is public
boolean	jsFunction_isSendEmail() Should an email be sent when the search is created?
void	jsFunction_setCriteria(CriteriaWrapper theCriteria) Set the criteria for this search.
void	jsFunction_setDescription(java.lang.String theDescription) Set the search description
void	jsFunction_setIgnoreAcl(boolean theIgnoreAcl) Set if the search should ignore the ACL and any root path or mandatory search there
void	jsFunction_setMetrics(boolean theIsMetrics) Sets if search should use metrics solr index.
void	jsFunction_setName(java.lang.String theName) Set the name of the search
void	jsFunction_setPublic(boolean thePublic) Set if the search is public
void	jsFunction_setSendEmail(boolean theSendEmail) Should an email be sent when the search is created?
void	jsFunction_setSortDirection(java.lang.String theSortDirection) Set sort direction.
void	jsFunction_setSortField(java.lang.String theSortField) Set sort field.
void	jsFunction_waitForSolrIndexingResult() Deprecated.
boolean	jsGet_shouldRethrowOnFailedSearch()
void	jsSet_shouldRethrowOnFailedSearch(boolean theShouldRethrowOnFailedSearch)

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, equivalentValues, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, has, hasInstance, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.javascript.Wrapper

unwrap

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Constructor Detail

SearchWrapper

public SearchWrapper()

Zero-arg constructor. Required for rhino.

Method Detail

jsConstructor

public void jsConstructor()

jsFunction_createQuickSearch

@Deprecated
public void jsFunction_createQuickSearch(java.lang.String theSearch,
                                                      JSSearchPreferences thePreferences)

Deprecated.

Parameters:

theSearch - the quick search string.

thePreferences - the SearchPreferences. (Uses default, if null.)

See Also:

JSSearchManager.jsFunction_createQuickSearch(String, JSSearchPreferences)

jsFunction_getCriteria

public CriteriaWrapper jsFunction_getCriteria()

Get the current criteria for this search.

Returns:

The current search criteria.

jsFunction_setCriteria

public void jsFunction_setCriteria(CriteriaWrapper theCriteria)

Set the criteria for this search.

Parameters:

theCriteria - The search criteria to set.

jsFunction_getName

public java.lang.String jsFunction_getName()

Get the name of the search

Returns:

the search name

jsFunction_setName

public void jsFunction_setName(java.lang.String theName)

Set the name of the search

Parameters:

theName - the search name

jsFunction_getID

public int jsFunction_getID()

Get the search ID

Returns:

the search ID

jsFunction_getDescription

public java.lang.String jsFunction_getDescription()

Get the search description

Returns:

the search description

jsFunction_setDescription

public void jsFunction_setDescription(java.lang.String theDescription)

Set the search description

Parameters:

theDescription - the search descripiton

jsFunction_isSendEmail

public boolean jsFunction_isSendEmail()

Should an email be sent when the search is created?

Returns:

true to send email, false otherwise

jsFunction_setSendEmail

public void jsFunction_setSendEmail(boolean theSendEmail)

Should an email be sent when the search is created?

Parameters:

theSendEmail - true to send email, false otherwise

jsFunction_setPublic

public void jsFunction_setPublic(boolean thePublic)

Set if the search is public

Parameters:

thePublic - true for a public search, false for a private search

jsFunction_setIgnoreAcl

public void jsFunction_setIgnoreAcl(boolean theIgnoreAcl)

Set if the search should ignore the ACL and any root path or mandatory search there

Parameters:

theIgnoreAcl - true to ignore ACL, false (default) to use ACL

jsFunction_getIgnoreAcl

public boolean jsFunction_getIgnoreAcl()

Returns true if the search will ignore the ACL and any mandatory search there

jsFunction_setMetrics

public void jsFunction_setMetrics(boolean theIsMetrics)

Sets if search should use metrics solr index.

Parameters:

theIsMetrics - is metrics?

jsFunction_isPublic

public boolean jsFunction_isPublic()

Get if the search is public

Returns:

true for a public search, false for a private search

jsFunction_setSortField

public void jsFunction_setSortField(java.lang.String theSortField)

Set sort field. Should be the full field name, e.g. "http://purl.org/dc/elements/1.1/ subject". Optional.

Parameters:

theSortField - The field to order by

jsFunction_getSortField

public java.lang.String jsFunction_getSortField()

Get this search object's sort field.

Returns:

The field to order by

jsFunction_setSortDirection

public void jsFunction_setSortDirection(java.lang.String theSortDirection)
                                 throws com.brightech.mb.web.search.SearchException

Set sort direction. Available orderings are searchManager.sortOrderings.asc and searchManger.sortOrderings.desc. If not specified, defaults to ascending.

Parameters:

theSortDirection - The order to sort results in.

Throws:

com.brightech.mb.web.search.SearchException

jsFunction_getSortDirection

public java.lang.String jsFunction_getSortDirection()

Get this search object's sort order. Should be "ASC", "DESC", or null.

Returns:

The current sort order.

jsFunction_execute

public void jsFunction_execute(org.mozilla.javascript.Function theCallback,
                               int thePageNumber,
                               int thePageSize)
                        throws jb.gwt_main_modules.base_widgets.client.exceptions.IterationException,
                               com.brightech.mb.web.search.SearchException,
                               java.lang.Exception

Execute this search, running the supplied callback after execution completes.

Parameters:

thePageNumber - The page number to start returning results from.

thePageSize - The number of items per page desired.

Throws:

jb.gwt_main_modules.base_widgets.client.exceptions.IterationException - If an error is encountered during execution of the search.

com.brightech.mb.web.search.SearchException - If the search is empty or the supplied criteria don't apply to the field. E.g. "begins with" doesn't really apply to a date field.

java.lang.Exception

jsGet_shouldRethrowOnFailedSearch

public boolean jsGet_shouldRethrowOnFailedSearch()

jsSet_shouldRethrowOnFailedSearch

public void jsSet_shouldRethrowOnFailedSearch(boolean theShouldRethrowOnFailedSearch)

jsFunction_executeForArray

public ManagedFile[] jsFunction_executeForArray(int thePageNumber,
                                                int thePageSize)
                                         throws java.lang.Exception

Execute this search

Parameters:

thePageNumber - The page number to start returning results from.

thePageSize - The number of items per page desired.

Returns:

an array of ManagedFile objects found by the search

Throws:

java.lang.Exception - If an error is encountered during execution of the search.

jsFunction_getSearchCount

public int jsFunction_getSearchCount()
                              throws com.brightech.mb.web.search.SearchException

Get the number of results from this search

Returns:

Throws:

com.brightech.mb.web.search.SearchException

jsFunction_getMetricsGraph

public java.lang.String jsFunction_getMetricsGraph(java.lang.String theSparklineField,
                                                   java.lang.String theLabel)
                                            throws jb.gwt_main_modules.base_widgets.client.exceptions.IterationException,
                                                   com.brightech.mb.web.search.SearchException

Execute this search, returning the JSON of the metrics graph.

Throws:

com.brightech.mb.web.search.SearchException - If the search is empty or the supplied criteria don't apply to the field. E.g. "begins with" doesn't really apply to a date field.

jb.gwt_main_modules.base_widgets.client.exceptions.IterationException

jsFunction_waitForSolrIndexingResult

@Deprecated
public void jsFunction_waitForSolrIndexingResult()
                                                       throws java.lang.InterruptedException

Deprecated.

Throws:

java.lang.InterruptedException - Thrown if this method is interrupted. Workflows should rethrow this exception if they catch it to ensure that interrupted workflows terminate properly.

See Also:

Perform this search with the solr search engine until we get a result (or timeout). Useful for determining if indexing has completed for a particular search.

jsFunction_getFacets

public FacetListWrapper jsFunction_getFacets(SolrConfigWrapper theSolrConfig)
                                      throws com.brightech.mb.web.search.SearchException

Get facets for a particular search.
Get the SolrConfig from searchManager.getR3SearchConfig().

Parameters:

theSolrConfig - r3search config to get facets for

Returns:

Throws:

com.brightech.mb.web.search.SearchException

See Also:

JSSearchManager.jsFunction_getR3SearchConfig(java.lang.String)

jsFunction_getTermsWithLimit

public FacetWrapper jsFunction_getTermsWithLimit(SolrConfigWrapper theSolrConfig,
                                                 int thePageNumber,
                                                 int thePageSize)

Gets terms (with count of number of assets containing the given term) for a given metadata field. Allows limiting the number of terms returned. Providing a negative limit will return Solr's limit of facets (defaults to 100)

Parameters:

theSolrConfig - the solr configuration

thePageNumber - the page number

thePageSize - the page size

Returns:

the facet with term and count information for the given field

jsFunction_getSearchString

public java.lang.String jsFunction_getSearchString()

Returns the search engine search string for this search.

Returns:

the search string.