oracle.workspaces.search
Class CwSearchResults

java.lang.Object
oracle.workspaces.search.CwSearchResults

public class CwSearchResults

extends java.lang.Object

This represents the conbined search results for a search query. A query can contain multiple containers in its scope; this object stores the search result set for each container as an independent set. It exposes API to get result sets based on original container object or container's entity type.

Constructor Summary

CwSearchResults(CwSearchResultSet[] containerResultSets)
Constructs an CwSearchResults given an array of search results.

Method Summary

CwSearchResultSet[]	listResultSets() Gets all result sets in this results.
CwSearchResultSet[]	listResultSets(CwEntityType searchEntityType) Gets the results sets corresponding to the specified search entity type.
CwSearchResultSet[]	listResultSets(CwSearchContainer container) Gets the results sets corresponding to the specified container object.
CwSearchResultSet[]	listResultSets(java.lang.String searchEntityTypeName) Same as listResultSets(CwEntityType searchEntityType) except that entity type name in String format can be used instead of CwEntityType object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CwSearchResults

public CwSearchResults(CwSearchResultSet[] containerResultSets)

Constructs an CwSearchResults given an array of search results. Generally, an array of search result set is constructed by executing a query.

Parameters:

containerResultSets - an array of search result set.

Method Detail

listResultSets

public CwSearchResultSet[] listResultSets()

Gets all result sets in this results. The number of result sets will be the same as the number of containers in the search query.

Returns:

An array of all result sets in this results object.

listResultSets

public CwSearchResultSet[] listResultSets(CwEntityType searchEntityType)

Gets the results sets corresponding to the specified search entity type. All the results sets that were computed for the entity type will be returned, if not such result set is found, then empty array is returned.

Parameters:

searchEntityType - the search entity type for which results sets are desired. This entity type must have been specified in some search containers of the query for this method to return non-empty array.

Returns:

an array of result sets that correspond to specified search entity type. If not such result set exist, then an empty array is returned.

See Also:

listResultSets(String searchEntityTypeName)

listResultSets

public CwSearchResultSet[] listResultSets(CwSearchContainer container)

Gets the results sets corresponding to the specified container object. The specified container object should be one of the containers in the search query for this method to return non-empty array.

Parameters:

container - the container object for which result sets are desired. Since search query does not enforce unique containers, there could be multiple results set for a container object. Container object is considered to match the result set's container if they are logically equal.

Returns:

an array of result sets that correspond to the given container. If no result set match the container, then empty array will be returned.

listResultSets

public CwSearchResultSet[] listResultSets(java.lang.String searchEntityTypeName)

Same as listResultSets(CwEntityType searchEntityType) except that entity type name in String format can be used instead of CwEntityType object.

Parameters:

searchEntityTypeName - the entity type name for which result sets are desired.

Returns:

an array of result sets that correspond to specified search entity type name. If not such result set exist, then an empty array is returned.

See Also:

listResultSets(CwEntityType searchEntityType)