Project JXTA

net.jxta.meter
Class MonitorFilter

java.lang.Object
  extended by net.jxta.meter.MonitorFilter
All Implemented Interfaces:
DocumentSerializable

public class MonitorFilter
extends Object
implements DocumentSerializable

A Monitor Filter specifies which service-specific metrics should be obtained by the Monitor. It contains a collection of ServiceMonitor specific ServiceMonitorFilters.


Constructor Summary
MonitorFilter()
          MonitorFilter
MonitorFilter(String description)
          MonitorFilter
 
Method Summary
 ServiceMonitorFilter addServiceMonitorFilter(ServiceMonitorFilter serviceMonitorFilter)
          Add a ServiceMonitorFilter to this MonitorFilter
 String getDescription()
          Get Description
 Iterator getModuleClassIDs()
          get ModuleClassIDs of contained subfilters
 ServiceMonitorFilter getServiceMonitorFilter(ModuleClassID moduleClassID)
          Get ServiceMonitorFilter subfilter
 int getServiceMonitorFilterCount()
          Get the number of subfilters
 Iterator getServiceMonitorFilters()
          Get Iterator of all ServiceMonitorFilters subfilters
 Iterator getUnknownModuleClassIDs()
          Get a list of ModuleClassIDs for subfilters that could not be deserialized because they weren't registered
 void initializeFrom(Element element)
          
 boolean isUnknownModuleClassIDs()
          Were any filters removed from this MonitorFilter (particularly when received remotely and deserialized)
 void removeServiceMonitorFilter(ModuleClassID moduleClassID)
          remove ServiceMonitorFilter
 void serializeTo(Element element)
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MonitorFilter

public MonitorFilter()
MonitorFilter


MonitorFilter

public MonitorFilter(String description)
MonitorFilter

Parameters:
description -
Method Detail

addServiceMonitorFilter

public ServiceMonitorFilter addServiceMonitorFilter(ServiceMonitorFilter serviceMonitorFilter)
                                             throws MonitorFilterException
Add a ServiceMonitorFilter to this MonitorFilter

Parameters:
serviceMonitorFilter - Service Specific Filter
Returns:
ServiceMonitorFilter Modified Filter to the capabilities of the service
Throws:
MonitorFilterException

getServiceMonitorFilter

public ServiceMonitorFilter getServiceMonitorFilter(ModuleClassID moduleClassID)
Get ServiceMonitorFilter subfilter

Parameters:
moduleClassID - ServiceMonitor's moduleClassID
Returns:
ServiceMonitorFilter SubFilter or null if not found

removeServiceMonitorFilter

public void removeServiceMonitorFilter(ModuleClassID moduleClassID)
remove ServiceMonitorFilter

Parameters:
moduleClassID - ServiceMonitor's moduleClassID

getServiceMonitorFilterCount

public int getServiceMonitorFilterCount()
Get the number of subfilters

Returns:
int

getModuleClassIDs

public Iterator getModuleClassIDs()
get ModuleClassIDs of contained subfilters

Returns:
Iterator of ServiceMonitor ClassIDs

getServiceMonitorFilters

public Iterator getServiceMonitorFilters()
Get Iterator of all ServiceMonitorFilters subfilters

Returns:
Iterator of all ServiceMonitorFilters subfilters

isUnknownModuleClassIDs

public boolean isUnknownModuleClassIDs()
Were any filters removed from this MonitorFilter (particularly when received remotely and deserialized)


getUnknownModuleClassIDs

public Iterator getUnknownModuleClassIDs()
Get a list of ModuleClassIDs for subfilters that could not be deserialized because they weren't registered

Returns:
Iterator
See Also:
MonitorResources

getDescription

public String getDescription()
Get Description


serializeTo

public void serializeTo(Element element)
                 throws DocumentSerializationException

Specified by:
serializeTo in interface DocumentSerializable
Throws:
DocumentSerializationException

initializeFrom

public void initializeFrom(Element element)
                    throws DocumentSerializationException

Specified by:
initializeFrom in interface DocumentSerializable
Throws:
DocumentSerializationException

JXTA J2SE