com.ibm.etools.iseries.rse.ui.view
Class SelectQSYSObjectAPIProvider

java.lang.Object
  SystemSelectRemoteObjectAPIProviderImpl
      com.ibm.etools.iseries.rse.ui.view.SelectQSYSObjectAPIProvider

public class SelectQSYSObjectAPIProvider
extends SystemSelectRemoteObjectAPIProviderImpl

This class is a provider of root nodes to the remote systems tree viewer part, optimized for selecting of iSeries QSYS file system objects. It is used in the AS400SelectObjectForm class.

It allows setting of an object filter string that is used to subset the object list by name and/or type, independent of the libraries. That is, a user might start by seeing a list of libraries on the library list, but when each is expanded the objects returned are subsetted by that object filter. Added @SuppressWarnings("restriction") since class org.eclipse.rse.internal.ui.view.SystemSelectRemoteObjectAPIProviderImpl is internal in openRSE. Need to address this later.

Field Summary

static String	copyright
protected ISeriesFieldFilterString	fldListFilterString
protected String	fldNameFilter
protected String	mbrNameFilter
protected String[]	mbrTypesFilter
protected ISeriesMemberFilterString	memberListFilterString
protected ISeriesObjectFilterString	objectListFilterString
protected String	objNameFilter
protected String[]	objTypesFilter
protected boolean	rcdOrFldMode

Constructor Summary

SelectQSYSObjectAPIProvider()
Constructor for ISeriesSelectQSYSObjectAPIProvider

Method Summary

String	getFieldFilterStringUsingNameFilter(String library, String file, String rcdToExpand) Return the filter string for resolving children of a record, using pre-supplied field name filtering criteria
String	getMemberFilterStringUsingNameAndTypeFilter(String library, String fileToExpand) Return the filter string for resolving children of a file, using pre-supplied member name and type filtering criteria
String	getObjectFilterStringUsingNameAndTypeFilter(String libraryToExpand) Return the filter string for resolving children of a library, using pre-supplied object name and type filtering criteria
boolean	isRecordAndFieldMode() Query if this is a special mode for listing records or fields.
void	setFieldNameFilter(String fldNameFilter) Set the name use to filter fields when a record is expanded.
void	setMemberNameAndTypeFilter(String mbrNameFilter, String[] mbrTypesFilter) Set the name and type to use to filter members when a file is expanded.
void	setObjectNameAndTypeFilter(String objNameFilter, String[] objTypesFilter) Set the name and type to use to filter objects when a library is expanded.
void	setRecordAndFieldMode(boolean set) Specify this is a special mode for listing records or fields.

Methods inherited from class java.lang.Object

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

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

objectListFilterString

protected ISeriesObjectFilterString objectListFilterString

objNameFilter

protected String objNameFilter

objTypesFilter

protected String[] objTypesFilter

memberListFilterString

protected ISeriesMemberFilterString memberListFilterString

mbrNameFilter

protected String mbrNameFilter

mbrTypesFilter

protected String[] mbrTypesFilter

fldListFilterString

protected ISeriesFieldFilterString fldListFilterString

fldNameFilter

protected String fldNameFilter

rcdOrFldMode

protected boolean rcdOrFldMode

Constructor Detail

SelectQSYSObjectAPIProvider

public SelectQSYSObjectAPIProvider()

Constructor for ISeriesSelectQSYSObjectAPIProvider

Method Detail

setRecordAndFieldMode

public void setRecordAndFieldMode(boolean set)

Specify this is a special mode for listing records or fields. In this mode, when *FILE objects are expanded, records are listed instead of members. Once a record is available it can be expanded to fields.

isRecordAndFieldMode

public boolean isRecordAndFieldMode()

Query if this is a special mode for listing records or fields. In this mode, when *FILE objects are expanded, records are listed instead of members. Once a record is available it can be expanded to fields.

setObjectNameAndTypeFilter

public void setObjectNameAndTypeFilter(String objNameFilter,
                                       String[] objTypesFilter)

Set the name and type to use to filter objects when a library is expanded. Either can be null to mean "all". Each object type filter is of the form "type:attr".

setMemberNameAndTypeFilter

public void setMemberNameAndTypeFilter(String mbrNameFilter,
                                       String[] mbrTypesFilter)

Set the name and type to use to filter members when a file is expanded. Either can be null to mean "all".

setFieldNameFilter

public void setFieldNameFilter(String fldNameFilter)

Set the name use to filter fields when a record is expanded. Can be null to mean "all".

getObjectFilterStringUsingNameAndTypeFilter

public String getObjectFilterStringUsingNameAndTypeFilter(String libraryToExpand)

Return the filter string for resolving children of a library, using pre-supplied object name and type filtering criteria

getMemberFilterStringUsingNameAndTypeFilter

public String getMemberFilterStringUsingNameAndTypeFilter(String library,
                                                          String fileToExpand)

Return the filter string for resolving children of a file, using pre-supplied member name and type filtering criteria

getFieldFilterStringUsingNameFilter

public String getFieldFilterStringUsingNameFilter(String library,
                                                  String file,
                                                  String rcdToExpand)

Return the filter string for resolving children of a record, using pre-supplied field name filtering criteria