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

java.lang.Object
  com.ibm.etools.iseries.comm.filters.ISeriesObjectTypeAttrList

public class ISeriesObjectTypeAttrList
extends Object

A class used by the ISeriesObjectFilterString to encapsulate all object type and object attribute pairs

See Also:

ISeriesObjectFilterString, ISeriesObjectTypeAttr

Field Summary

static String

Copyright

Constructor Summary

ISeriesObjectTypeAttrList()
Constructor to use when there is no existing string of type:attr pairs.

ISeriesObjectTypeAttrList(String input)
Constructor to use when a string of type:attr pairs already exists.

Method Summary

void	addObjectType(String typeAttr) Add an object type:attr pair given as a String.
void	addObjectTypeAttr(ISeriesObjectTypeAttr typeAttr) Add an object type:attr pair given as an ISeriesObjectTypeAttr object.
String	getObjectAttr(int index) Return the object attribute string (without the type part) at the given zero-based index.
String	getObjectType(int index) Return the object type string (without the attribute part) at the given zero-based index.
ISeriesObjectTypeAttr	getObjectTypeAttr(int index) Return the object type and attribute pair at the given zero-based index, as an ISeriesObjectTypeAttr object.
ISeriesObjectTypeAttr	getObjectTypeAttr(String type) Return the ISeriesObjectTypeAttr object for the given type, or null if there is no such type in this list
int	getObjectTypeCount() Return number of object type pairs
String	getUniqueAttr() If this type list has only one unique attribute, return it.
String	getUniqueType() If this type list has only one unique type, return it.
String	toString() Convert this filter into a string of the form type:attr type:attr type:attr.
String[]	toStringArray() Convert this filter into an array of strings, each of the form type:attr.

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

Constructor Detail

ISeriesObjectTypeAttrList

public ISeriesObjectTypeAttrList()

Constructor to use when there is no existing string of type:attr pairs. This results in a default single pair of *:*. To subsequent add pairs call:

addObjectType(String) to add a single type:attr that is a raw string.

addObjectTypeAttr(ISeriesObjectTypeAttr) to add a single type:attr encapsulated as an object of class ISeriesObjectTypeAttr

ISeriesObjectTypeAttrList

public ISeriesObjectTypeAttrList(String input)

Constructor to use when a string of type:attr pairs already exists. Each pair must be blank separated.

Method Detail

getObjectTypeCount

public int getObjectTypeCount()

Return number of object type pairs

getUniqueType

public String getUniqueType()

If this type list has only one unique type, return it. Else returns null meaning there is more than one unique type in this list.

getUniqueAttr

public String getUniqueAttr()

If this type list has only one unique attribute, return it. Else returns null meaning there is more than one unique attribute in this list.

getObjectTypeAttr

public ISeriesObjectTypeAttr getObjectTypeAttr(int index)

Return the object type and attribute pair at the given zero-based index, as an ISeriesObjectTypeAttr object.

getObjectType

public String getObjectType(int index)

Return the object type string (without the attribute part) at the given zero-based index.

getObjectAttr

public String getObjectAttr(int index)

Return the object attribute string (without the type part) at the given zero-based index.

addObjectType

public void addObjectType(String typeAttr)

Add an object type:attr pair given as a String.

addObjectTypeAttr

public void addObjectTypeAttr(ISeriesObjectTypeAttr typeAttr)

Add an object type:attr pair given as an ISeriesObjectTypeAttr object.

getObjectTypeAttr

public ISeriesObjectTypeAttr getObjectTypeAttr(String type)

Return the ISeriesObjectTypeAttr object for the given type, or null if there is no such type in this list

toString

public String toString()

Convert this filter into a string of the form type:attr type:attr type:attr.

Overrides:

toString in class Object

toStringArray

public String[] toStringArray()

Convert this filter into an array of strings, each of the form type:attr.