Rational Developer for Power Systems Software
V7.6

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

java.lang.Object
  extended by com.ibm.etools.iseries.comm.filters.ISeriesObjectTypeAttr

public class ISeriesObjectTypeAttr
extends Object

A class used by the ISeriesObjectFilterString to encapsulate each object type and object attribute pair.

See Also:
ISeriesObjectFilterString

Field Summary
static String ALL_ATTRS
           
static String ALL_TYPES
           
static String Copyright
           
 
Constructor Summary
ISeriesObjectTypeAttr()
          Constructor to use when there is no existing type:attr pair.
ISeriesObjectTypeAttr(String input)
          Constructor to use when a type:attr pair already exists.
 
Method Summary
 String getObjectAttr()
          Return the object attribute part of this type:attr pair.
 String getObjectType()
          Return the object type part of this type:attr pair.
 boolean isGeneric()
          Returns true if either the type or the attribute is generic.
 void setObjectAttr(String attr)
          Set the object attribute part of this type:attr pair.
 void setObjectType(String type)
          Set the object type part of this type:attr pair.
 String toString()
          Convert this filter into a string of the form type:attr.
static boolean verifyObjectType(String type)
          Utility method to ensure an object type is syntactically valid.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values

ALL_TYPES

public static final String ALL_TYPES
See Also:
Constant Field Values

ALL_ATTRS

public static final String ALL_ATTRS
See Also:
Constant Field Values
Constructor Detail

ISeriesObjectTypeAttr

public ISeriesObjectTypeAttr()
Constructor to use when there is no existing type:attr pair. This results in a default pair of *:*. To change any of the default values call:
  • setObjectType(String) to set the object type.
  • setObjectAttr(String) to set the object attribute. This attribute applies to the object type. However, if the type is '*' then this is a global subset-by-attribute filter.


  • ISeriesObjectTypeAttr

    public ISeriesObjectTypeAttr(String input)
    Constructor to use when a type:attr pair already exists. To get the actual filter string from object of this class, just call toString().

    Method Detail

    getObjectType

    public String getObjectType()
    Return the object type part of this type:attr pair.

    See Also:
    setObjectType(String)

    getObjectAttr

    public String getObjectAttr()
    Return the object attribute part of this type:attr pair.

    See Also:
    setObjectAttr(String)

    setObjectType

    public void setObjectType(String type)
    Set the object type part of this type:attr pair.

    Parameters:
    type - The object type, as in *FILE. Do not include the attribute with this! The type should be a valid AS/400 type or *. Other than *, the type cannot be generic.
    See Also:
    getObjectType()

    setObjectAttr

    public void setObjectAttr(String attr)
    Set the object attribute part of this type:attr pair.

    Parameters:
    attr - The object attribute, as in PF-SRC. Do not include the type with this! The attribute can be scalar name, or *, or a valid generic name with one or two asterisks anywhere in it.
    See Also:
    getObjectAttr()

    toString

    public String toString()
    Convert this filter into a string of the form type:attr.

    Overrides:
    toString in class Object

    isGeneric

    public boolean isGeneric()
    Returns true if either the type or the attribute is generic.


    verifyObjectType

    public static boolean verifyObjectType(String type)
    Utility method to ensure an object type is syntactically valid. This amounts to it starting with an asterisk, and having no other asterisks in the name.


    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.