IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.ras.profile.management.artifact.filter
Interface IArtifactAttributeFilter

All Superinterfaces:
IArtifactFilter, ICaseSensitiveArtifactFilter
All Known Implementing Classes:
AbstractArtifactAttributeFilterImpl

public interface IArtifactAttributeFilter
extends ICaseSensitiveArtifactFilter

The IArtifactAttributeFilter provides the ability to filter on an attribute of an Artifact. The client sets the method that should be invoked to retrieve the attibute from the Artifact as well as the Object that is used to compare against during the filtering process. This interface can be implemented by clients. However an abstract class has been provided to simplify the implementation.

See Also:
AbstractArtifactAttributeFilterImpl

Method Summary
 Object getFilterObject()
          Retrieves the Object that is used to compare against during the filtering process.
 String getMethodName()
          Retrieves the name of the method that will be invoked on the Artifact that is used to retrieve an attribute of the Artifact during filtering.
 void setFilterObject(Object filterObject)
          Sets the Object that is used to compare against during the filtering process.
 void setMethodName(String methodName)
          Sets the name of the method that will be invoked on the Artifact that is used to retrieve an attribute of the Artifact during filtering.
 
Methods inherited from interface com.ibm.xtools.ras.profile.management.artifact.filter.ICaseSensitiveArtifactFilter
isCaseSensitive, setCaseSensitive
 
Methods inherited from interface com.ibm.xtools.ras.profile.management.artifact.filter.IArtifactFilter
matches
 

Method Detail

getMethodName

public String getMethodName()
Retrieves the name of the method that will be invoked on the Artifact that is used to retrieve an attribute of the Artifact during filtering.

Returns:
the name of the method that will be invoked on the Artifact

setMethodName

public void setMethodName(String methodName)
                   throws SecurityException,
                          NoSuchMethodException,
                          NullPointerException
Sets the name of the method that will be invoked on the Artifact that is used to retrieve an attribute of the Artifact during filtering. This should be the name of a public method that does not take any parameters. It should also return some form of an Object.

Parameters:
methodName - the name of the method that will be invoked on the Artifact
Throws:
NoSuchMethodException - - if a matching method is not found or if the method name is "" or "".
NullPointerException - - if method name is null
SecurityException - - if access to the information is denied.

getFilterObject

public Object getFilterObject()
Retrieves the Object that is used to compare against during the filtering process.

Returns:
the Object that is used to compare against during the filtering process.

setFilterObject

public void setFilterObject(Object filterObject)
Sets the Object that is used to compare against during the filtering process. This Object can be null providing the ability to filter for Artifact instances that have a particular attribute set to null.

Parameters:
filterObject - the Object that is used to compare against during the filtering process. It can be null

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.