Define Carma Filter
Identifier:
com.ibm.carma.ui.defineCarmaFilters
Since:
8.0.2
Description:
This extension point is used to define a Carma filter to be used to decide what elements to display for a defined RAM.
Configuration Markup:
<!ELEMENT extension (defineCarmaFilter*)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT defineCarmaFilter EMPTY>
<!ATTLIST defineCarmaFilter
uniqueId CDATA #REQUIRED
filterLevel CDATA #REQUIRED
filterDefinitionProcess CDATA #REQUIRED
class CDATA #IMPLIED
filterDefault CDATA #IMPLIED>
Defines a Carma filter to be used when displaying Carma resources.
- uniqueId - the unique identifier of the CARMA RAM
- filterLevel - A filter can be defined to apply to all Carma resources or to specific Carma resources. The acceptable values are "ALL", "RAM", "REPOSITORYINSTANCE" or "CONTAINER".
- filterDefinitionProcess - specifies how the filter definition should be obtained. The acceptable values are: "PROMPT", "CLASS" or "DEFAULT".
"PROMPT" will cause the end user to be prompted to define the filter if no current filter exists for the Carma resource level that is being expanded.
"CLASS" will cause the defined class to be invoked to obtain the filter string. If the "CLASS" value is specified, then the class attribute must also be defined.
"DEFAULT" will will cause the defined filterDefault value to be used. If the "DEFAULT" value is specified, then the filterDefault attribute must also be defined.
- class - the Carma Filter definition implementation, must implement com.ibm.carma.ui.ICarmaDefineFilters
- filterDefault - The default filter to use for the defined RAM and filterLevel.
Examples:
Defining Carma filters:
<extension point="com.ibm.carma.ui.defineCarmaFilters">
<defineCarmaFilter
uniqueId="MYRAM"
filterLevel="RAM"
filterDefinitionProcess="CLASS"
class="com.example.MyCarmaFilter"
</defineCarmaFilter>
<defineCarmaFilter
uniqueId="MYRAM"
filterLevel="REPOSITORYINSTANCE"
filterDefinitionProcess="DEFAULT"
filterDefault="USER161*"
</defineCarmaFilter>
<defineCarmaFilter
uniqueId="MYRAM"
filterLevel="CONTAINER"
filterDefinitionProcess="PROMPT"
</defineCarmaFilter>
</extension>
API Information:
If the class attribute is defined, it must represent an implementation of com.ibm.carma.ui.ICarmaDefineFilters.
Supplied Implementation:
Plug-ins may use this extension point to define filters to be used when displaying CARMA resources.
Copyright IBM Corp. 2011 All Rights Reserved
|
This information center is powered by Eclipse technology. (http://www.eclipse.org)