netcharts.server.api
Interface NDSPostProcessorInterfaceInfo

All Known Subinterfaces:

NDSPostProcessorInterfaceInfoV2

public interface NDSPostProcessorInterfaceInfo

This interface is used to create informative classes for Process Modules. By creating a class that implements the NDSPostProcessorInterfaceInfo, information about the Process Module can be introduced into NetCharts Server and NetCharts Designer. To create an informative class for a Process Module, implement this interface and name the informative class the same name as the Process Module, in the same package, with Info appended to the class name. For instance, if the Process Module was named com.modules.MyProcessModule, then the informative class should be named com.modules.MyProcessModuleInfo.

Method Summary

java.util.Hashtable	getAdditionalParameters() Returns a Hashtable containing the set of additional, non-configurable parameters, that need to be included if this Process Module is utilized.
java.lang.String	getDescription() Returns a more detailed description of the Process Module.
boolean	getIsIndexed() Returns whether the parameter are indexed and has the index appended to the name of the parameter.
java.lang.String	getName() Returns the descriptive name of the Process Module.
NDSPostProcessorInterfaceParameterInfo[]	getParameters() Returns a concat array containing the set of parameters that the Process Module utilizes.

Method Detail

getName

public java.lang.String getName()

Returns the descriptive name of the Process Module.

Returns:

String containing a descriptive name of the Process Module.

getDescription

public java.lang.String getDescription()

Returns a more detailed description of the Process Module.

Returns:

String containing a description of the Process Module.

getIsIndexed

public boolean getIsIndexed()

Returns whether the parameter are indexed and has the index appended to the name of the parameter. For instance, if the parameter name was MyParameter, and the Process Module was the second Process Module called in the chain of processing, then the parameter used would be MyParameter2

Returns:

boolean true if the indices are indexed, false otherwise.

getParameters

public NDSPostProcessorInterfaceParameterInfo[] getParameters()

Returns a concat array containing the set of parameters that the Process Module utilizes. If no parameters are used, then null or an empty array can be returned.

Returns:

NDSPostProcessorInterfaceParameterInfo[] containing the set of parameters used by the Process Module.

getAdditionalParameters

public java.util.Hashtable getAdditionalParameters()

Returns a Hashtable containing the set of additional, non-configurable parameters, that need to be included if this Process Module is utilized. If no parameters are needed, then null should be returned.

Returns:

A Hashtable containing the set of additional, non-configurable parameters.