com.raritantechnologies.searchApp.utils
Class ResultUtils

java.lang.Object
  com.raritantechnologies.searchApp.utils.ResultUtils

public class ResultUtils

extends java.lang.Object

Utilities for basic manipulation IResult and IResultSet objects and for executing searches using an RTI Search Source (used in background or 'lookup' searches).

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

ResultUtils()

Method Summary

static boolean	compareResults(IResult res1, IResult res2, java.lang.String field)
static boolean	compareResults(IResult res1, IResult res2, java.lang.String[] fields)
static void	copyFields(IResult fromRes, IResult toRes)
static void	copyFields(IResult fromRes, IResult toRes, java.util.Set includedFields)
static void	copyFields(IResult fromRes, IResult toRes, java.util.Set includedFields, boolean copyNested)
static IResult	copyResult(IResult res) returns a copy of an IResult.
static IResult	copyResult(IResult res, java.util.Set fields)
static IResult	copyResult(IResult res, java.util.Set fields, boolean copyNested)
static void	copyResultFields(IResult fromResult, IResult toResult, java.lang.String[] fields)
static IResultSet	copyResultSet(IResultSet resSet)
static IResultSet	copyResultSet(IResultSet resSet, int pageSize, int startRec)
static IResultSet	copyResultSet(IResultSet resSet, ResultSetSorter sorter)
static IResultSet	filterResultSet(IResultSet source, ILoginInfo user, IQueryResultMatcher qResMatcher, OrderedMap queryParams)
static IResultSet	filterResultSet(IResultSet source, ILoginInfo user, IQueryResultMatcher qResMatcher, OrderedMap queryParams, boolean adjustTotalDocs)
static IResultSet	filterResultSet(IResultSet source, ILoginInfo user, IResultMatcher resMatcher) Filters a Result Set using an IResultMatcher.
static IResultSet	filterResultSet(IResultSet source, ILoginInfo user, IResultMatcher resMatcher, boolean adjustTotalDocs)
static java.util.ArrayList	getFieldValues(IResult result, java.lang.String fieldID)
static java.util.ArrayList	getFieldValues(IResult result, java.lang.String fieldID, java.lang.String delimiter)
static IResult	getFirstResult(SearchSource theSource, OrderedMap query, ILoginInfo userInfo) Gets one result from a SearchSource
static IResult	getFirstResult(java.lang.String searchSourceName, OrderedMap query, ILoginInfo userInfo) Gets one result from a SearchSource
static IResult	getMatchingResult(IResultSet source, ILoginInfo user, IResultMatcher resMatcher)
static IResultSet	getNestedResults(IResult result, java.lang.String fieldPath)
static IResultSet	getNestedResults(IResult result, java.lang.String fieldPath, java.lang.String pathDelimiter)
static java.lang.String	getNestedValue(IResult result, java.lang.String fieldPath)
static java.util.ArrayList	getNestedValues(IResult result, java.lang.String fieldPath)
static java.util.ArrayList	getNestedValues(IResult result, java.lang.String fieldPath, java.lang.String pathDelimiter)
static java.util.ArrayList	getNestedValues(IResult result, java.lang.String fieldPath, java.lang.String pathDelimiter, boolean exactPathOnly)
static java.util.ArrayList	getResults(SearchSource theSource, OrderedMap query, ILoginInfo userInfo, int pSize) Gets all of the results from a SearchSource returns a java.util.ArrayList of IResultSet objects.
static java.util.ArrayList	getResults(SearchSource theSource, OrderedMap query, ILoginInfo userInfo, int pSize, int maxDocs)
static java.util.ArrayList	getResults(java.lang.String searchSourceName, OrderedMap query)
static java.util.ArrayList	getResults(java.lang.String searchSourceName, OrderedMap query, ILoginInfo userInfo)
static java.util.ArrayList	getResults(java.lang.String searchSourceName, OrderedMap query, ILoginInfo userInfo, int pSize) Gets all of the results from a SearchSource returns a java.util.ArrayList of IResultSet objects.
static java.util.ArrayList	getResults(java.lang.String searchSourceName, OrderedMap query, ILoginInfo userInfo, int pSize, int maxDocs)
static boolean	hasMatchingResult(IResultSet source, ILoginInfo user, IResultMatcher resMatcher)
static java.util.ArrayList	sortResults(java.util.ArrayList resultLst, OrderedMap inputParameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultUtils

public ResultUtils()

Method Detail

getFieldValues

public static java.util.ArrayList getFieldValues(IResult result,
                                                 java.lang.String fieldID)

getFieldValues

public static java.util.ArrayList getFieldValues(IResult result,
                                                 java.lang.String fieldID,
                                                 java.lang.String delimiter)

getNestedValue

public static java.lang.String getNestedValue(IResult result,
                                              java.lang.String fieldPath)

getNestedValues

public static java.util.ArrayList getNestedValues(IResult result,
                                                  java.lang.String fieldPath)

getNestedValues

public static java.util.ArrayList getNestedValues(IResult result,
                                                  java.lang.String fieldPath,
                                                  java.lang.String pathDelimiter)

getNestedValues

public static java.util.ArrayList getNestedValues(IResult result,
                                                  java.lang.String fieldPath,
                                                  java.lang.String pathDelimiter,
                                                  boolean exactPathOnly)

getNestedResults

public static IResultSet getNestedResults(IResult result,
                                          java.lang.String fieldPath)

getNestedResults

public static IResultSet getNestedResults(IResult result,
                                          java.lang.String fieldPath,
                                          java.lang.String pathDelimiter)

copyResult

public static IResult copyResult(IResult res)

returns a copy of an IResult.

copyResult

public static IResult copyResult(IResult res,
                                 java.util.Set fields)

copyResult

public static IResult copyResult(IResult res,
                                 java.util.Set fields,
                                 boolean copyNested)

copyFields

public static void copyFields(IResult fromRes,
                              IResult toRes)

copyFields

public static void copyFields(IResult fromRes,
                              IResult toRes,
                              java.util.Set includedFields)

copyFields

public static void copyFields(IResult fromRes,
                              IResult toRes,
                              java.util.Set includedFields,
                              boolean copyNested)

copyResultSet

public static IResultSet copyResultSet(IResultSet resSet)

copyResultSet

public static IResultSet copyResultSet(IResultSet resSet,
                                       ResultSetSorter sorter)

copyResultSet

public static IResultSet copyResultSet(IResultSet resSet,
                                       int pageSize,
                                       int startRec)

copyResultFields

public static void copyResultFields(IResult fromResult,
                                    IResult toResult,
                                    java.lang.String[] fields)

getResults

public static java.util.ArrayList getResults(java.lang.String searchSourceName,
                                             OrderedMap query)

getResults

public static java.util.ArrayList getResults(java.lang.String searchSourceName,
                                             OrderedMap query,
                                             ILoginInfo userInfo)

getResults

public static java.util.ArrayList getResults(java.lang.String searchSourceName,
                                             OrderedMap query,
                                             ILoginInfo userInfo,
                                             int pSize)

Gets all of the results from a SearchSource returns a java.util.ArrayList of IResultSet objects.

getResults

public static java.util.ArrayList getResults(java.lang.String searchSourceName,
                                             OrderedMap query,
                                             ILoginInfo userInfo,
                                             int pSize,
                                             int maxDocs)

getResults

public static java.util.ArrayList getResults(SearchSource theSource,
                                             OrderedMap query,
                                             ILoginInfo userInfo,
                                             int pSize)

Gets all of the results from a SearchSource returns a java.util.ArrayList of IResultSet objects.

getResults

public static java.util.ArrayList getResults(SearchSource theSource,
                                             OrderedMap query,
                                             ILoginInfo userInfo,
                                             int pSize,
                                             int maxDocs)

getFirstResult

public static IResult getFirstResult(java.lang.String searchSourceName,
                                     OrderedMap query,
                                     ILoginInfo userInfo)

Gets one result from a SearchSource

getFirstResult

public static IResult getFirstResult(SearchSource theSource,
                                     OrderedMap query,
                                     ILoginInfo userInfo)

Gets one result from a SearchSource

filterResultSet

public static IResultSet filterResultSet(IResultSet source,
                                         ILoginInfo user,
                                         IResultMatcher resMatcher)

Filters a Result Set using an IResultMatcher.

filterResultSet

public static IResultSet filterResultSet(IResultSet source,
                                         ILoginInfo user,
                                         IResultMatcher resMatcher,
                                         boolean adjustTotalDocs)

filterResultSet

public static IResultSet filterResultSet(IResultSet source,
                                         ILoginInfo user,
                                         IQueryResultMatcher qResMatcher,
                                         OrderedMap queryParams)

filterResultSet

public static IResultSet filterResultSet(IResultSet source,
                                         ILoginInfo user,
                                         IQueryResultMatcher qResMatcher,
                                         OrderedMap queryParams,
                                         boolean adjustTotalDocs)

hasMatchingResult

public static boolean hasMatchingResult(IResultSet source,
                                        ILoginInfo user,
                                        IResultMatcher resMatcher)

getMatchingResult

public static IResult getMatchingResult(IResultSet source,
                                        ILoginInfo user,
                                        IResultMatcher resMatcher)

sortResults

public static java.util.ArrayList sortResults(java.util.ArrayList resultLst,
                                              OrderedMap inputParameters)

compareResults

public static boolean compareResults(IResult res1,
                                     IResult res2,
                                     java.lang.String[] fields)

compareResults

public static boolean compareResults(IResult res1,
                                     IResult res2,
                                     java.lang.String field)