de.uni_hildesheim.sse.monitoring.runtime.configuration.xml

Class XMLHandler

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.configuration.xml.XMLHandler

All Implemented Interfaces:

DocHandler

class XMLHandler
extends java.lang.Object
implements DocHandler

Implements the XML handler.

Since:

1.00

Version:

1.23

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
private HashMap<java.lang.String,java.lang.Boolean>	analyzeMembers Just stores whether the most detailed type of annotation attachment per class is a member (true) or not (false).
private HashMap<java.lang.String,AnnotationBuilderMap>	configuration Stores the configuration, i.e. a mapping from signatures to annotation types to annotation builders.
private ArrayList<PathElement>	currentPath Stores the current path of modules and namespaces.
private boolean	exclusive Stores if this configuration is exclusive, i.e. authoritative or if it may overlap with source code annotations.
private HashMap<java.lang.String,MonitoringGroupConfiguration>	groupConfigurations Stores the monitoring group configurations collected during XML file reading.
private boolean	hasPatterns Stores whether this configuration contains patterns.
private ArrayList<Pattern>	patterns Stores the patterns collected during XML file reading.
private ArrayList<Pattern>	patternStack Stores the actual stack of patterns as read from the XML file.
private static java.lang.String	TAG_MONITOR Defines the name of the "monitor" tag/annotation.
private ArrayList<AnnotationBuilder<?>>	templateStack Stores the actual stack of annotation builders as read from the XML file.
private HashMap<java.lang.String,java.lang.String>	unresolvedConfigurations Stores referenced but unresolved configurations (temporary attribute, to be resolved at the end of processing.

Constructor Summary

Constructors

Constructor and Description
XMLHandler()

Method Summary

Modifier and Type	Method and Description
private void	appendToCurrentPath(PathElement.Type type, java.lang.String name, java.lang.String pattern) Appends a name to the current path.
private boolean	currentPathContainsPattern() Returns whether the current path contains a pattern.
void	endDocument() Receive notification of the end of the document.
void	endElement(java.lang.String tag) Ends reading an element.
(package private) HashMap<java.lang.String,java.lang.Boolean>	getAnalyzeMembers() Returns the mapping between class names and whether code analysis of members is required according to the configuration.
private Pattern	getClosestPattern() Returns the closest pattern.
(package private) HashMap<java.lang.String,AnnotationBuilderMap>	getConfiguration() Returns the configuration constructed while reading an XML file.
private java.lang.String	getCurrentPath(boolean asRegEx) Returns the current path by calculating it from the path elements.
(package private) HashMap<java.lang.String,MonitoringGroupConfiguration>	getGroupConfigurations() Returns the monitoring group configurations identified while reading an XML file.
(package private) ArrayList<Pattern>	getPatterns() Returns the patterns identified while reading an XML file.
(package private) boolean	isExclusive() Returns whether this configuration is exclusive, i.e. source code annotations should not be considered.
private PathElement.Type	modifyPath(java.lang.String tag, HashMap<java.lang.String,java.lang.String> attributes) Modifies the path according to the name of the element and its attributes.
private Pattern	parsePatterns(PathElement.Type type, java.lang.String currentPath, java.lang.String typeOf, AnnotationBuilder<?> template) Registers the given pattern for the current path and parses, if provided, the type restrictions in typeOf.
private void	recordAnnotationLevel() Records the (deepest) annotation level for the current path.
private Pattern	registerPattern(java.lang.String currentPath, java.lang.String typeOf, AnnotationBuilder<?> template) Registers the given pattern (for the current path and if provided the type restriction).
private void	removeLastFromCurrentPath() Removes the last name from the current path.
private void	setMonitorAnnotationConfigurationDefaults(AnnotationBuilder<?> builder, HashMap<java.lang.String,java.lang.String> attributes) Sets configuration defaults for the monitor annotation.
private void	setPlainTime() Sets analyzeMembers based on already read configuration settings, in particular whether we are instrumenting for plain time resources only.
void	startDocument() Start of an XML Document.
void	startElement(java.lang.String tag, HashMap<java.lang.String,java.lang.String> attributes) Start of an XML Element.
void	text(java.lang.String str) Text node content.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG_MONITOR

private static final java.lang.String TAG_MONITOR

Defines the name of the "monitor" tag/annotation.

See Also:

Constant Field Values

configuration

private HashMap<java.lang.String,AnnotationBuilderMap> configuration

Stores the configuration, i.e. a mapping from signatures to annotation types to annotation builders.

analyzeMembers

private HashMap<java.lang.String,java.lang.Boolean> analyzeMembers

Just stores whether the most detailed type of annotation attachment per class is a member (true) or not (false). May be null if plain time recording is not configured as default monitoring, i.e., other resources are considered by default.

Since:

1.13

exclusive

private boolean exclusive

Stores if this configuration is exclusive, i.e. authoritative or if it may overlap with source code annotations. Default is true.

templateStack

private ArrayList<AnnotationBuilder<?>> templateStack

Stores the actual stack of annotation builders as read from the XML file.

patternStack

private ArrayList<Pattern> patternStack

Stores the actual stack of patterns as read from the XML file.

currentPath

private ArrayList<PathElement> currentPath

Stores the current path of modules and namespaces.

patterns

private ArrayList<Pattern> patterns

Stores the patterns collected during XML file reading.

groupConfigurations

private HashMap<java.lang.String,MonitoringGroupConfiguration> groupConfigurations

Stores the monitoring group configurations collected during XML file reading.

unresolvedConfigurations

private HashMap<java.lang.String,java.lang.String> unresolvedConfigurations

Stores referenced but unresolved configurations (temporary attribute, to be resolved at the end of processing.

hasPatterns

private boolean hasPatterns

Stores whether this configuration contains patterns.

Since:

1.13

Constructor Detail

XMLHandler

XMLHandler()

Method Detail

isExclusive

boolean isExclusive()

Returns whether this configuration is exclusive, i.e. source code annotations should not be considered.

Returns:

true if this configuration is exclusive, false else

Since:

1.00

getAnalyzeMembers

HashMap<java.lang.String,java.lang.Boolean> getAnalyzeMembers()

Returns the mapping between class names and whether code analysis of members is required according to the configuration.

Returns:

the mapping of (Java) class names and whether analysis is required, null if all classes must be considered

Since:

1.13

getConfiguration

HashMap<java.lang.String,AnnotationBuilderMap> getConfiguration()

Returns the configuration constructed while reading an XML file.

Returns:

the configuration

Since:

1.00

getPatterns

ArrayList<Pattern> getPatterns()

Returns the patterns identified while reading an XML file.

Returns:

the patterns

Since:

1.00

getGroupConfigurations

HashMap<java.lang.String,MonitoringGroupConfiguration> getGroupConfigurations()

Returns the monitoring group configurations identified while reading an XML file.

Returns:

the group configurations

Since:

1.00

appendToCurrentPath

private void appendToCurrentPath(PathElement.Type type,
                                 java.lang.String name,
                                 java.lang.String pattern)

Appends a name to the current path.

Parameters:

type - the type of the path element

name - the name to be appended

pattern - the pattern or null

Since:

1.00

removeLastFromCurrentPath

private void removeLastFromCurrentPath()

Removes the last name from the current path.

Since:

1.00

setPlainTime

private void setPlainTime()

Sets analyzeMembers based on already read configuration settings, in particular whether we are instrumenting for plain time resources only.

Since:

1.13

currentPathContainsPattern

private boolean currentPathContainsPattern()

Returns whether the current path contains a pattern.

Returns:

true for pattern, false else

Since:

1.23

getCurrentPath

private java.lang.String getCurrentPath(boolean asRegEx)

Returns the current path by calculating it from the path elements.

Parameters:

asRegEx - should the result be given as a matching regular expression

Returns:

the current path

Since:

1.00

modifyPath

private PathElement.Type modifyPath(java.lang.String tag,
                                    HashMap<java.lang.String,java.lang.String> attributes)

Modifies the path according to the name of the element and its attributes.

Parameters:

tag - the name of the element

attributes - the attributes of tag, may be null in order to trigger removal of the last path element if the current XML element allows this

Returns:

the type of the element

Since:

1.00

recordAnnotationLevel

private void recordAnnotationLevel()

Records the (deepest) annotation level for the current path.

Since:

1.13

startElement

public void startElement(java.lang.String tag,
                         HashMap<java.lang.String,java.lang.String> attributes)
                  throws QdParserException

Start of an XML Element.

Specified by:

startElement in interface DocHandler

Parameters:

tag - element name

attributes - element attributes

Throws:

QdParserException - parse error

getClosestPattern

private Pattern getClosestPattern()

Returns the closest pattern.

Returns:

the closest pattern (may be null for none)

Since:

1.21

setMonitorAnnotationConfigurationDefaults

private void setMonitorAnnotationConfigurationDefaults(AnnotationBuilder<?> builder,
                                                       HashMap<java.lang.String,java.lang.String> attributes)

Sets configuration defaults for the monitor annotation.

Parameters:

builder - the annotation builder

attributes - the actual attributes

Since:

1.20

parsePatterns

private Pattern parsePatterns(PathElement.Type type,
                              java.lang.String currentPath,
                              java.lang.String typeOf,
                              AnnotationBuilder<?> template)
                       throws QdParserException

Registers the given pattern for the current path and parses, if provided, the type restrictions in typeOf.

Parameters:

type - the type of the path element

currentPath - the current path (to the specified elements)

typeOf - the type restriction (may be multiple separated by commas, may be one, may be empty, may be null)

template - the annotation template

Returns:

the created pattern (may be null for none)

Throws:

QdParserException - in case of any parsing/interpretation error

Since:

1.00

registerPattern

private Pattern registerPattern(java.lang.String currentPath,
                                java.lang.String typeOf,
                                AnnotationBuilder<?> template)
                         throws QdParserException

Registers the given pattern (for the current path and if provided the type restriction).

Parameters:

currentPath - the current path (to the specified elements)

typeOf - a type restriction, i.e. the name of an interface or a class or null

template - the annotation template

Returns:

the created pattern object

Throws:

QdParserException - in case of any parsing/interpretation error

Since:

1.00

endElement

public void endElement(java.lang.String tag)
                throws QdParserException

Ends reading an element. Cleans up the stack and delegates to the annotation builder instance.

Specified by:

endElement in interface DocHandler

Parameters:

tag - the element name

Throws:

QdParserException - in case of reading errors

endDocument

public void endDocument()
                 throws QdParserException

Receive notification of the end of the document. Processes unresolvedConfigurations.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of a document (such as finalising a tree or closing an output file).

Specified by:

endDocument in interface DocHandler

Throws:

QdParserException - in case of reading errors

text

public void text(java.lang.String str)
          throws QdParserException

Text node content.

Specified by:

text in interface DocHandler

Parameters:

str - node content

Throws:

QdParserException - parse error

startDocument

public void startDocument()
                   throws QdParserException

Start of an XML Document.

Specified by:

startDocument in interface DocHandler

Throws:

QdParserException - parse error