wt.query
Class SearchAttributeList

java.lang.Object
  wt.query.SearchAttributeList

All Implemented Interfaces:

Externalizable, SearchAttributeListDelegate, Serializable

Direct Known Subclasses:

PickerSearchAttributeList, WTDocumentAttributeList, WTPartAttributeList

public class SearchAttributeList

extends Object

implements SearchAttributeListDelegate, Externalizable

This class is used to set the drop dow list, search criteria, and search result columns for HTML Local Search. This class has been deprecated in X05 and all newly developed search UIs should use the Advanced Search DCA Picker. Please see the customization guide for search for more information. To use this list set the following property in wt.properties: wt.query.searchAttributeList=STANDARD To customize and change the drop down, search criteria, and search result columns in the local search attributes: 1. Sub-class this class and change the setLocale method to use different lists. Two constructors will also be required. See below: public SearchAttributeList( Locale locale ) { setLocale(locale); } public SearchAttributeList() { return; } 2. Add an entry into service.properties similar to: wt.services/svc/default/wt.query.SearchAttributeListDelegate/MINE/java.lang.Object/0=mine.MySearchAttributeList/duplicate 3. Change the entry in the wt.properties to: wt.query.searchAttributeList=MINE

Supported API: true

Extendable: true

See Also:

Serialized Form

Field Summary

protected int	classCount Deprecated.
private static String	CLASSNAME Deprecated.
protected Locale	clientLocale Deprecated.
private static String	CODEBASE Deprecated.
protected String	currentQueryResource Deprecated.
static long	EXTERNALIZATION_VERSION_UID Deprecated.
protected int	index Deprecated.
protected static String[]	inputAttributes Deprecated.
protected static String[]	inputProcessing Deprecated.
static String	NULL_PARAMETER Deprecated.
protected static long	OLD_FORMAT_VERSION_UID Deprecated.
protected static String[]	outputAttributes Deprecated.
protected static String[]	outputProcessing Deprecated.
protected String[]	pickList Deprecated.
protected String[]	pickValues Deprecated.
protected static String[]	queryClass Deprecated.
private static String	RESOURCE Deprecated.
(package private) static long	serialVersionUID Deprecated.
protected static String[]	sortAttributes Deprecated.
protected static String[]	sortPref Deprecated.
private static boolean	VERBOSE Deprecated.

Constructor Summary

SearchAttributeList()
Deprecated.

SearchAttributeList(Locale locale)
Deprecated.

Method Summary

Vector	getAllSortAttributes(int query_type) Deprecated. Return the list of attributes for all the attributes that can be sorted.
Vector	getInputAttributes(int query_type) Deprecated.
Vector	getInputProcessing(int query_type) Deprecated.
Vector	getOutputAttributes(int query_type) Deprecated.
Vector	getOutputProcessing(int query_type) Deprecated.
Vector	getPickList() Deprecated.
Vector	getPickValues() Deprecated.
static Vector	getPropertyDescriptors(Vector attributes, Class class_name) Deprecated.
static Vector	getPropertyDescriptors(Vector attributes, Vector classes) Deprecated.
Vector	getQueryClass(int query_type) Deprecated.
String	getQueryResource() Deprecated. Gets the current query resource file.
int	getQueryType(String value) Deprecated.
Vector	getSortAttributes(int query_type) Deprecated. Return the list of attributes for only the attributes that can be sorted.
Vector[]	getSortedPick() Deprecated.
int[]	getSortedQueryType(String value) Deprecated.
String	getSortKey(int query_type) Deprecated. Return the sort key for a query type Supported API: false
Vector	getSortList(int query_type) Deprecated. Return the list of display attributes for only the attributes that can be sorted.
private Vector	getStringVector(String[] array, int query_type) Deprecated.
void	readExternal(ObjectInput input) Deprecated.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated. Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(SearchAttributeList thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated.
void	setLocale(Locale locale) Deprecated.
String	setQueryResource(String theQueryResource) Deprecated. Sets the query resource file to use.
void	writeExternal(ObjectOutput output) Deprecated.

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

Deprecated.

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Deprecated.

serialVersionUID

static final long serialVersionUID

Deprecated.

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

Deprecated.

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

Deprecated.

See Also:

Constant Field Values

index

protected int index

Deprecated.

classCount

protected int classCount

Deprecated.

pickList

protected String[] pickList

Deprecated.

pickValues

protected String[] pickValues

Deprecated.

clientLocale

protected Locale clientLocale

Deprecated.

queryClass

protected static String[] queryClass

Deprecated.

inputAttributes

protected static String[] inputAttributes

Deprecated.

inputProcessing

protected static String[] inputProcessing

Deprecated.

outputAttributes

protected static String[] outputAttributes

Deprecated.

outputProcessing

protected static String[] outputProcessing

Deprecated.

sortAttributes

protected static String[] sortAttributes

Deprecated.

sortPref

protected static String[] sortPref

Deprecated.

currentQueryResource

protected String currentQueryResource

Deprecated.

CODEBASE

private static String CODEBASE

Deprecated.

VERBOSE

private static boolean VERBOSE

Deprecated.

NULL_PARAMETER

public static final String NULL_PARAMETER

Deprecated.

See Also:

Constant Field Values

Constructor Detail

SearchAttributeList

public SearchAttributeList(Locale locale)

Deprecated.

Supported API: false

Parameters:

locale -

SearchAttributeList

public SearchAttributeList()

Deprecated.

Supported API: false

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Deprecated.

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

Deprecated.

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(SearchAttributeList thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Deprecated.

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

Deprecated.

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

setLocale

public void setLocale(Locale locale)

Deprecated.

Used to initialize the lists for drop down list, search critieria, and search result columns.

Supported API: false

Specified by:

setLocale in interface SearchAttributeListDelegate

Parameters:

locale -

getPickList

public Vector getPickList()

Deprecated.

Get the list of displayable values for the picklist.

Supported API: false

Specified by:

getPickList in interface SearchAttributeListDelegate

Returns:

Vector

getPickValues

public Vector getPickValues()

Deprecated.

Get the value for the pick list.

Supported API: false

Specified by:

getPickValues in interface SearchAttributeListDelegate

Returns:

Vector

getQueryType

public int getQueryType(String value)
                 throws WTException

Deprecated.

Given the pick for the class return the index for the query type. Used to get the rest of the values.

Supported API: false

Specified by:

getQueryType in interface SearchAttributeListDelegate

Parameters:

value -

Returns:

int

Throws:

WTException

getQueryClass

public Vector getQueryClass(int query_type)
                     throws WTException

Deprecated.

Supported API: false

Specified by:

getQueryClass in interface SearchAttributeListDelegate

Parameters:

query_type -

Returns:

Vector

Throws:

WTException

getInputAttributes

public Vector getInputAttributes(int query_type)
                          throws WTException

Deprecated.

Supported API: false

Specified by:

getInputAttributes in interface SearchAttributeListDelegate

Parameters:

query_type -

Returns:

Vector

Throws:

WTException

getPropertyDescriptors

public static Vector getPropertyDescriptors(Vector attributes,
                                            Class class_name)
                                     throws WTException

Deprecated.

Supported API: false

Parameters:

attributes -

class_name -

Returns:

Vector

Throws:

WTException

getPropertyDescriptors

public static Vector getPropertyDescriptors(Vector attributes,
                                            Vector classes)
                                     throws WTException

Deprecated.

Supported API: false

Parameters:

attributes -

classes -

Returns:

Vector

Throws:

WTException

getInputProcessing

public Vector getInputProcessing(int query_type)
                          throws WTException

Deprecated.

Supported API: false

Specified by:

getInputProcessing in interface SearchAttributeListDelegate

Parameters:

query_type -

Returns:

Vector

Throws:

WTException

getOutputAttributes

public Vector getOutputAttributes(int query_type)
                           throws WTException

Deprecated.

Supported API: false

Specified by:

getOutputAttributes in interface SearchAttributeListDelegate

Parameters:

query_type -

Returns:

Vector

Throws:

WTException

getOutputProcessing

public Vector getOutputProcessing(int query_type)
                           throws WTException

Deprecated.

Supported API: false

Specified by:

getOutputProcessing in interface SearchAttributeListDelegate

Parameters:

query_type -

Returns:

Vector

Throws:

WTException

getSortedPick

public Vector[] getSortedPick()

Deprecated.

This method should be used to return a sorted list of Object Types that is sorted using localized values

Supported API: false

Specified by:

getSortedPick in interface SearchAttributeListDelegate

Returns:

Vector []

getSortedQueryType

public int[] getSortedQueryType(String value)
                         throws WTException

Deprecated.

Supported API: false

Specified by:

getSortedQueryType in interface SearchAttributeListDelegate

Parameters:

value -

Returns:

int []

Throws:

WTException

getStringVector

private Vector getStringVector(String[] array,
                               int query_type)
                        throws WTException

Deprecated.

Throws:

WTException

getSortAttributes

public Vector getSortAttributes(int query_type)
                         throws WTException

Deprecated.

Return the list of attributes for only the attributes that can be sorted.

Supported API: false

Specified by:

getSortAttributes in interface SearchAttributeListDelegate

Parameters:

query_type -

Returns:

Vector

Throws:

WTException

getSortList

public Vector getSortList(int query_type)
                   throws WTException

Deprecated.

Return the list of display attributes for only the attributes that can be sorted.

Supported API: false

Specified by:

getSortList in interface SearchAttributeListDelegate

Parameters:

query_type -

Returns:

Vector

Throws:

WTException

getAllSortAttributes

public Vector getAllSortAttributes(int query_type)
                            throws WTException

Deprecated.

Return the list of attributes for all the attributes that can be sorted. Put in blanks for attributes that can't be sorted.

Supported API: false

Specified by:

getAllSortAttributes in interface SearchAttributeListDelegate

Parameters:

query_type -

Returns:

Vector

Throws:

WTException

getSortKey

public String getSortKey(int query_type)

Deprecated.

Return the sort key for a query type

Supported API: false

Specified by:

getSortKey in interface SearchAttributeListDelegate

Parameters:

query_type -

Returns:

String

setQueryResource

public String setQueryResource(String theQueryResource)

Deprecated.

Sets the query resource file to use.

Supported API: false

Parameters:

theQueryResource -

Returns:

String

getQueryResource

public String getQueryResource()

Deprecated.

Gets the current query resource file.

Supported API: false

Returns:

String