de.aristaflow.adept2.model.common.systemdata

Class SystemDataTools

java.lang.Object

de.aristaflow.adept2.model.common.systemdata.SystemDataTools

public final class SystemDataTools
extends java.lang.Object

This utility class provides methods to deal with parameter references in the strings returned by SystemDataConsumer annotated methods.

Author:

Patrick Schmidt

Method Summary

Modifier and Type	Method and Description
static ParameterRef[]	findParameterReferences(java.lang.String parameterisedString) Finds all parameter references (see SystemDataConsumer) in the given string and returns them.
static ParameterRefParser	getParser(java.lang.String parameterisedString) Returns a parser for the specified parameterised string.
static ParameterRefReplacer	getReplacer(java.lang.String parameterisedString) Returns a replacer for the specified parameterised string to replace parameter references with actual values.
static boolean	isCompatibleParameter(ParameterRef paramRef, Parameter parameter) Returns true, if the parameter reference and the given parameter are compatible.
static ParameterRef	parseParameterReference(java.lang.String parameterReference) Parses the specified string representation of a parameter reference (including the enclosing '%'s) and returns it as a ParameterRef object (or null if the reference is in any way illegal).

Methods inherited from class java.lang.Object

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

Method Detail

findParameterReferences

public static ParameterRef[] findParameterReferences(java.lang.String parameterisedString)

Finds all parameter references (see SystemDataConsumer) in the given string and returns them. This method will avoid returning duplicates (i.e. two parameter references that exactly match in name and type).

This method will only recognise parameter references with data types that are supported by system/node parameters (INTEGER, FLOAT and STRING).

Parameters:

parameterisedString - a string, potentially containing variables / parameter references

Returns:

all parameter references found in the string

parseParameterReference

public static ParameterRef parseParameterReference(java.lang.String parameterReference)

Parses the specified string representation of a parameter reference (including the enclosing '%'s) and returns it as a ParameterRef object (or null if the reference is in any way illegal).

This method will only recognise parameter references with data types that are supported by system/node parameters (INTEGER, FLOAT and STRING).

Parameters:

parameterReference - string representation of a parameter reference

Returns:

a parsed ParameterRef object or null if the reference is in any way illegal

getParser

public static ParameterRefParser getParser(java.lang.String parameterisedString)

Returns a parser for the specified parameterised string. The advantage compared to findParameterReferences(String) is that the parser provides position information (start and end index of parameter reference).

This method will only recognise parameter references with data types that are supported by system/node parameters (INTEGER, FLOAT and STRING).

Parameters:

parameterisedString - the parameterised string to be formatted

Returns:

a formatter for the specified parameterised string

getReplacer

public static ParameterRefReplacer getReplacer(java.lang.String parameterisedString)

Returns a replacer for the specified parameterised string to replace parameter references with actual values.

This method will only recognise parameter references with data types that are supported by system/node parameters (INTEGER, FLOAT and STRING).

Parameters:

parameterisedString - the parameterised string to be processed

Returns:

a replacer for the specified parameterised string

isCompatibleParameter

public static boolean isCompatibleParameter(ParameterRef paramRef,
                                            Parameter parameter)

Returns true, if the parameter reference and the given parameter are compatible.

Parameters:

paramRef - Parameter reference.

parameter - Real parameter.

Returns:

True, if the parameter reference and the given parameter are compatible.