Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm.filters
Class ISeriesLibraryFilterString

java.lang.Object
  extended by com.ibm.etools.iseries.comm.filters.ISeriesAbstractFilterString
      extended by com.ibm.etools.iseries.comm.filters.ISeriesObjectFilterString
          extended by com.ibm.etools.iseries.comm.filters.ISeriesLibraryFilterString

public class ISeriesLibraryFilterString
extends ISeriesObjectFilterString

A class representing an AS/400 Library filter string. This is a name pattern for returning lists of AS/400 libraries when used as input to the ISeriesListLibraries class (specifically the getList methods in this class). To use this class, just instantiate it and call setObject(String) to set the library name. A scalar name or generic name with one or two asterisks anywhere in the name is supported. To get the actual filter string from objects of this class, just call toString(). Note that this ISeriesLibraryFilterString is a child class of ISeriesObjectFilterString, since library filters are really just object filters with a library of QSYS and a type of *LIB. However, for special cases *LIBL, *CURLIB and *USRLIBL, a different host API is used to get the information. Be careful not to call setLibrary(String) versus of setObject(String)!. Remember, the library is always QSYS for library list requests.

See Also:
ISeriesListLibraries

Field Summary
static String Copyright
           
static String CURLIB
          "*CURLIB".
static String LIBL
          "*LIBL".
static String USRLIBL
          "*USRLIBL".
 
Fields inherited from class com.ibm.etools.iseries.comm.filters.ISeriesObjectFilterString
ALL, DEFAULT_LIBRARY, DEFAULT_OBJTYPE
 
Fields inherited from class com.ibm.etools.iseries.comm.filters.ISeriesAbstractFilterString
WILDCARD
 
Constructor Summary
ISeriesLibraryFilterString()
          Constructor to use when there is no existing filter string.
ISeriesLibraryFilterString(String input)
          Constructor to use when filter string (eg "*LIBL" or "A*") already exists.
 
Method Summary
 String getLibrary()
          Returns containing library name which is always QSYS for library filters.
 String getLibraryPadded()
          Return library name padded to 10 characters with blanks.
 String getObject()
          Returns library pattern name, such as *LIBL or A*.
 String getObjectType()
          Returns object type which is always *LIB for library filters.
 boolean isGeneric()
          Returns true if current filter represents a generic name versus a scalar name.
 boolean isMultiGeneric()
          Returns true if current filter represents a generic name that has more than one generic name part.
 boolean isSpecialLibFilter()
          Returns true if this is a special library filter.
 void setLibrary(String lib)
          This must always be QSYS for library filters SO YOU REALLY WANT TO USE SETOBJECT.
 void setObject(String obj)
          Set the library name pattern, such as "*LIBL" or "A*" or "ABC*DEF".
 void setObjectType(String type)
          Set the object type which must always be *LIB for library filters.
 String toString()
          Returns filter as a string.
 String toStringFull()
          Returns filter as an object list string.
 
Methods inherited from class com.ibm.etools.iseries.comm.filters.ISeriesObjectFilterString
getObjectTypeArray, getObjectTypeAttrList, isMultiTyped, matchesType, setObjectTypeAttrList, setObjectTypes, verifyObjectType
 
Methods inherited from class com.ibm.etools.iseries.comm.filters.ISeriesAbstractFilterString
addQuotes, clone, countHostOccurrencesOf, countOccurrencesOf, createFilterStringObject, equals, hashCode, hostIndexOf, hostIndexOf, isGenericLibraryName, isGenericName, isQuoted, stripQuotes, verifyGenericName, verifyGenericNameAdvanced, verifyGenericNameAdvancedQuoted, verifyGenericNameQuoted
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values

LIBL

public static final String LIBL
"*LIBL". For listing libraries on library list.

See Also:
Constant Field Values

CURLIB

public static final String CURLIB
"*CURLIB". For listing current library.

See Also:
Constant Field Values

USRLIBL

public static final String USRLIBL
"*USRLIBL". For listing libraries on user part of library list.

See Also:
Constant Field Values
Constructor Detail

ISeriesLibraryFilterString

public ISeriesLibraryFilterString()
Constructor to use when there is no existing filter string. Gives a default filter of *LIBL, but this can be changed by calling setObject(String).


ISeriesLibraryFilterString

public ISeriesLibraryFilterString(String input)
Constructor to use when filter string (eg "*LIBL" or "A*") already exists.

Method Detail

getLibraryPadded

public String getLibraryPadded()
Return library name padded to 10 characters with blanks.


isSpecialLibFilter

public boolean isSpecialLibFilter()
Returns true if this is a special library filter. That is, true if the library name is *CURLIB, *LIBL or *USRLIBL.


toString

public String toString()
Returns filter as a string. Eg, "*LIBL" or "A*".

Overrides:
toString in class ISeriesObjectFilterString

toStringFull

public String toStringFull()
Returns filter as an object list string. Eg "QSYS/A* OBJTYPE(*LIB)"

Overrides:
toStringFull in class ISeriesObjectFilterString

isGeneric

public boolean isGeneric()
Returns true if current filter represents a generic name versus a scalar name.

Overrides:
isGeneric in class ISeriesObjectFilterString

isMultiGeneric

public boolean isMultiGeneric()
Returns true if current filter represents a generic name that has more than one generic name part. Not possible for library lists.

Overrides:
isMultiGeneric in class ISeriesObjectFilterString

getLibrary

public String getLibrary()
Returns containing library name which is always QSYS for library filters.

Overrides:
getLibrary in class ISeriesObjectFilterString
See Also:
getObject()

getObject

public String getObject()
Returns library pattern name, such as *LIBL or A*.

Overrides:
getObject in class ISeriesObjectFilterString

getObjectType

public String getObjectType()
Returns object type which is always *LIB for library filters.

Overrides:
getObjectType in class ISeriesObjectFilterString
See Also:
ISeriesObjectFilterString.setObjectType(String)

setLibrary

public void setLibrary(String lib)
This must always be QSYS for library filters SO YOU REALLY WANT TO USE SETOBJECT. The library is always set to QSYS for you by this class, so do not call this method.

Overrides:
setLibrary in class ISeriesObjectFilterString
See Also:
ISeriesListObjects

setObject

public void setObject(String obj)
Set the library name pattern, such as "*LIBL" or "A*" or "ABC*DEF". Can be a scalar name for lists of one, or a generic name containing one or two asterisks anywhere in the name. Special values supported are *LIBL, *CURLIB, *USRLIBL, *ALL, *ALLUSR.

Overrides:
setObject in class ISeriesObjectFilterString

setObjectType

public void setObjectType(String type)
Set the object type which must always be *LIB for library filters. Not support for special library filters *LIBL, *CURLIB or *USRLIBL. Instead, use an ISeriesObjectFilterString object if this is desired.

Overrides:
setObjectType in class ISeriesObjectFilterString

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.