com.portal.search

Class SearchData

java.lang.Object

com.portal.search.SearchData

All Implemented Interfaces:

Serializable

public class SearchData
extends Object
implements Serializable

This class contains information necessary for doing searches.

Version:

%version: 8 % %date_modified: Wed Jan 02 11:49:04 2002 %

Author:

mgaines

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CTRL_INFO Indicates an operation for retrieving control information for a given template.
static int	GENERIC_SEARCH_FLDS Indicates an operation for stopping a search
static int	GENERIC_TMPL Indicates an operation required to display information for a generic template.
static int	GENERIC_TMPL_FIELDS Indicates an operation required for retrieving fields information to display in the generic template.
ControlInfo	mClass
ControlInfo	mField
static int	SEARCH Indicates a search operation.
static int	SET_RESULTS Indicates an operation for setting the results for the search.
static int	STOP_SEARCH Indicates an operation for stopping a search

Constructor Summary

Constructors

Constructor and Description
SearchData(int type) Creates an instance of this data class.
SearchData(int type, SearchTemplate tmpl) Creates an instance of this data class.
SearchData(int type, SearchTemplate[] templates) Creates an instance of this data class.
SearchData(int type, String str) Creates an instance of this data class.
SearchData(int type, String[] fields) Creates an instance of this data class.
SearchData(int type, String[] arg, ControlInfo ciClass, ControlInfo ciField, SearchTemplate st) Creates an instance of this data class.

Method Summary

Modifier and Type	Method and Description
String	getClassString()
Hashtable	getControlInfo()
String[]	getFields()
String[]	getGenericSearchArgs()
PModelHandle	getHandle()
String	getSpec()
String[]	getSubclasses()
SearchTemplate	getTemplate()
SearchTemplate[]	getTemplates()
int	getType()
void	setControlInfo(Hashtable cInfo) Sets the ControlInfo property.
void	setFields(String[] flds) Sets the fields for the generic template.
void	setHandle(PModelHandle h) Sets the model handle to be used in the client.
void	setSpec(String s) Sets the Spec property for a template.
void	setSubclasses(String[] sclass) Sets the subclasses for the generic template.
void	setTemplates(SearchTemplate[] tmpls) Sets the search templates property.

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH

public static final int SEARCH

Indicates a search operation.

See Also:

Constant Field Values

GENERIC_TMPL

public static final int GENERIC_TMPL

Indicates an operation required to display information for a generic template.

See Also:

Constant Field Values

GENERIC_TMPL_FIELDS

public static final int GENERIC_TMPL_FIELDS

Indicates an operation required for retrieving fields information to display in the generic template.

See Also:

Constant Field Values

SET_RESULTS

public static final int SET_RESULTS

Indicates an operation for setting the results for the search.

See Also:

Constant Field Values

CTRL_INFO

public static final int CTRL_INFO

Indicates an operation for retrieving control information for a given template.

See Also:

Constant Field Values

STOP_SEARCH

public static final int STOP_SEARCH

Indicates an operation for stopping a search

See Also:

Constant Field Values

GENERIC_SEARCH_FLDS

public static final int GENERIC_SEARCH_FLDS

Indicates an operation for stopping a search

See Also:

Constant Field Values

mClass

public ControlInfo mClass

mField

public ControlInfo mField

Constructor Detail

SearchData

public SearchData(int type,
                  SearchTemplate[] templates)

Creates an instance of this data class. This is used for initiating a search.

Parameters:

type - the operation this is used for

templates - the templates to use in the search.

SearchData

public SearchData(int type,
                  String str)

Creates an instance of this data class. This is used for retrieving field or subclass information related to the given class for the generic template.

Parameters:

type - the operation this is used for

str - the string representing a class

SearchData

public SearchData(int type)

Creates an instance of this data class. This is used for stopping an existing search.

Parameters:

type - the operation this is used for

SearchData

public SearchData(int type,
                  SearchTemplate tmpl)

Creates an instance of this data class. This is used for retrieving control information for a given template. Control information refers to the specific UI controls needed to display the correct search panel for the template.

Parameters:

type - the operation this is used for

tmpl - the SearchTemplate this control is for

SearchData

public SearchData(int type,
                  String[] fields)

Creates an instance of this data class. This is used for setting result fields for a search.

Parameters:

type - the operation this is used for

fields - the fields to use for search results

SearchData

public SearchData(int type,
                  String[] arg,
                  ControlInfo ciClass,
                  ControlInfo ciField,
                  SearchTemplate st)

Creates an instance of this data class. This is used in generic search data collection.

Parameters:

type - the operation this is used for

arg - 4 fields

Method Detail

setSubclasses

public void setSubclasses(String[] sclass)

Sets the subclasses for the generic template.

Parameters:

sclass - the array of subclasses

getSubclasses

public String[] getSubclasses()

Returns:

the subclasses for a class.

setFields

public void setFields(String[] flds)

Sets the fields for the generic template.

Parameters:

flds - the fields for the generic template

getFields

public String[] getFields()

Returns:

the fields for a subclass.

setTemplates

public void setTemplates(SearchTemplate[] tmpls)

Sets the search templates property.

Parameters:

tmpls - the array of SearchTemplates

getTemplates

public SearchTemplate[] getTemplates()

Returns:

the fields for a subclass.

getTemplate

public SearchTemplate getTemplate()

Returns:

the search template

setHandle

public void setHandle(PModelHandle h)

Sets the model handle to be used in the client.

Parameters:

h - the model handle

getHandle

public PModelHandle getHandle()

Returns:

the fields for a subclass.

getType

public int getType()

Returns:

the type of operation this object is used for

getClassString

public String getClassString()

Returns:

the string representation of the object

setControlInfo

public void setControlInfo(Hashtable cInfo)

Sets the ControlInfo property. This is used for translating the search template to a panel in the SearchPanel.

Parameters:

cInfo - hashtable containing control information

getControlInfo

public Hashtable getControlInfo()

Returns:

the hashtable containing control information for the template

setSpec

public void setSpec(String s)

Sets the Spec property for a template. This is used for building the the template string for the input of a search.

Parameters:

s - the string used in when building the search

getSpec

public String getSpec()

Returns:

the string used in when building the search

getGenericSearchArgs

public String[] getGenericSearchArgs()

Returns:

the string used in when building the search