Remote Systems
v6.4.1

com.ibm.etools.systems.filters.impl
Class SystemFilterContainerReferenceCommonMethods

java.lang.Object
  extended bycom.ibm.etools.systems.filters.impl.SystemFilterContainerReferenceCommonMethods

public class SystemFilterContainerReferenceCommonMethods
extends Object

Both SystemFilter and SystemFilterPool contain filters, so the common methods for filters are abstracted out in SystemFilterContainer, which both classes implement. Both SystemFilterReference and SystemFilterPoolReference hold references to SystemFilterContainer objects (either SystemFilter or SystemFilterPool). There are a couple of methods that are common to both classes, related to getting an array of references to the filters that are held by the referenced object. This class offers an implementation of those common methods, and both SystemFilterReferenceImpl and SystemFilterPoolReferenceImpl use this via containment.


Field Summary
static String copyright
           
 
Constructor Summary
SystemFilterContainerReferenceCommonMethods(SystemFilterContainerReference parentRef)
          Constructor
 
Method Summary
 SystemFilterReference generateAndRecordFilterReference(SystemFilter filter)
          Create a single filter refererence and append it to the end of the list.
 SystemFilterReference generateFilterReference(SystemFilter filter)
          Create a single filter refererence
 SystemFilterReference getExistingSystemFilterReference(SystemFilter filter)
          Return an existing reference to a given system filter.
 int getFilterCount()
          Return count of the number of filters in the referenced pool or filter
 String getName()
          Return the name of the SystemFilter or SystemFilterPool that we reference.
 SystemFilterReference[] getSystemFilterReferences()
          Get the list of nested filters referenced by this ISystemFilterContainerReference.
 boolean hasFilters()
          Return true if the referenced pool or filter has filters.
 
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
Constructor Detail

SystemFilterContainerReferenceCommonMethods

public SystemFilterContainerReferenceCommonMethods(SystemFilterContainerReference parentRef)
Constructor

Parameters:
parentRef - the object we are helping.
Method Detail

getName

public String getName()
Return the name of the SystemFilter or SystemFilterPool that we reference.


hasFilters

public boolean hasFilters()
Return true if the referenced pool or filter has filters.


getFilterCount

public int getFilterCount()
Return count of the number of filters in the referenced pool or filter


getSystemFilterReferences

public SystemFilterReference[] getSystemFilterReferences()
Get the list of nested filters referenced by this ISystemFilterContainerReference.


generateFilterReference

public SystemFilterReference generateFilterReference(SystemFilter filter)
Create a single filter refererence


generateAndRecordFilterReference

public SystemFilterReference generateAndRecordFilterReference(SystemFilter filter)
Create a single filter refererence and append it to the end of the list. This will first check if there already is a reference to the given filter and if so will simply return it.


getExistingSystemFilterReference

public SystemFilterReference getExistingSystemFilterReference(SystemFilter filter)
Return an existing reference to a given system filter. If no reference currently exists to this filter, returns null.


Remote Systems
v6.4.1

Copyright © 2005 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.