com.ptc.windchill.enterprise.search.server
Class SearchCriteriaHelper

java.lang.Object
  com.ptc.windchill.enterprise.search.server.SearchCriteriaHelper

All Implemented Interfaces:

Externalizable, Serializable

public final class SearchCriteriaHelper

extends Object

implements Externalizable

Contains helper methods for generating search query criteria.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

SearchCriteriaHelper()

Method Summary

(package private) static AttributeContainerSet	convertCollectionToACS(Collection col, boolean isUnion) Converts a collection of AttributeContainerSets into a single AttributeContainerSet Supported API: false
private static AttributeContainerSet	getContainerCriteria(SearchInfo searchInfo) Generate container criteria for a search.
private static AttributeContainerSet	getNullAndTerminalCriteria(SearchInfo searchInfo) If the type context is Persistable, a composite search criteria that gives all objects whose checkoutInfo.state != WorkInProgressState.TERMINAL or don't have a checkoutInfo.state attribute is returned.
private static AttributeContainerSet	getObjectRefCriteria(SearchInfo searchInfo) Generates object ref criteria for a search.
static AttributeContainerSet	getSearchCriteria(SearchInfo searchInfo) Gets all query criteria (where clause, object ref, container) for a search.
private static void	printObjectRefsException(String ufidString)
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(SearchCriteriaHelper thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

SearchCriteriaHelper

public SearchCriteriaHelper()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(SearchCriteriaHelper thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getSearchCriteria

public static AttributeContainerSet getSearchCriteria(SearchInfo searchInfo)
                                               throws WTException

Gets all query criteria (where clause, object ref, container) for a search.

Supported API: false

Parameters:

searchInfo -

Returns:

AttributeContainerSet

Throws:

WTException

getObjectRefCriteria

private static AttributeContainerSet getObjectRefCriteria(SearchInfo searchInfo)
                                                   throws WTException

Generates object ref criteria for a search.

Parameters:

searchInfo - This is the search information which contains the object type being searched for

Returns:

AttributeContainerSet

Throws:

WTException

getContainerCriteria

private static AttributeContainerSet getContainerCriteria(SearchInfo searchInfo)
                                                   throws WTException

Generate container criteria for a search.

Parameters:

searchInfo -

Returns:

AttributeContainerSet

Throws:

WTException

getNullAndTerminalCriteria

private static AttributeContainerSet getNullAndTerminalCriteria(SearchInfo searchInfo)
                                                         throws WTException

If the type context is Persistable, a composite search criteria that gives all objects whose checkoutInfo.state != WorkInProgressState.TERMINAL or don't have a checkoutInfo.state attribute is returned. If the type context is Workable, a search criteria for just checkoutInfo.state != WorkInProgressState.TERMINAL is returned.

Parameters:

searchInfo -

Returns:

AttributeContainerSet

Throws:

WTException

convertCollectionToACS

static AttributeContainerSet convertCollectionToACS(Collection col,
                                                    boolean isUnion)
                                             throws WTException

Converts a collection of AttributeContainerSets into a single AttributeContainerSet

Supported API: false

Parameters:

col -

isUnion -

Returns:

AttributeContainerSet

Throws:

WTException

printObjectRefsException

private static void printObjectRefsException(String ufidString)