com.highqsoft.importtool

Class CommonRules

java.lang.Object

com.highqsoft.importtool.CommonRules

public class CommonRules
extends java.lang.Object

Implementation of import rule methods. Import rule methods are used to populate more complex attributes. These attributes could depend on other instance elements or even external circumstances.

Since:

$Date: 2017/04/06 13:29:19 $

Version:

$Revision: 1.23 $

Author:

Markus Schuldlos

Constructor Summary

Constructors

Constructor and Description
CommonRules() Create a new Rules object.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	buildNumericVersion(InstanceElement instElem, java.util.Hashtable constants, java.lang.String meaName) Build the numeric version for concerto.
java.lang.String	connectStrings(InstanceElement instElem, java.util.Hashtable constants, java.lang.String p1, java.lang.String p2) Connect two Strings.
java.lang.String	connectStrings(InstanceElement instElem, java.util.Hashtable constants, java.lang.String p1, java.lang.String p2, java.lang.String p3) Connect three strings
java.lang.String	connectStrings(InstanceElement instElem, java.util.Hashtable constants, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4) Connect four Strings
java.lang.String	connectStrings(InstanceElement instElem, java.util.Hashtable constants, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4, java.lang.String p5) Connect five Strings
java.lang.String	connectStrings(InstanceElement instElem, java.util.Hashtable constants, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4, java.lang.String p5, java.lang.String p6) Connect six Strings
java.lang.String	connectStrings(InstanceElement instElem, java.util.Hashtable constants, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4, java.lang.String p5, java.lang.String p6, java.lang.String p7) Connect seven Strings
java.lang.String	connectStrings(InstanceElement instElem, java.util.Hashtable constants, java.lang.String p1, java.lang.String p2, java.lang.String p3, java.lang.String p4, java.lang.String p5, java.lang.String p6, java.lang.String p7, java.lang.String p8) Connect eight Strings
java.lang.String	getByName(InstanceElement instElem, java.util.Hashtable constants, java.lang.String aeName, java.lang.String ieName) Get an instance of an application element by its name.
java.lang.String	getDescriptionFromValFile(InstanceElement instElem, java.util.Hashtable constants, java.lang.String defValue) Reads the description for a constant found in a .VAL file.
java.lang.String	getFromAny(InstanceElement instElem, java.util.Hashtable constants, java.lang.String applElem, java.lang.String requestedAttr, java.lang.String searchAttr, java.lang.String searchString) Get an attribute of the instance matching the search criteria.
java.lang.String	getMeaVersion(InstanceElement instElem, java.util.Hashtable constants, java.lang.String dummy)
java.lang.String	getNextLongVersion(InstanceElement instElem, java.util.Hashtable constants, java.lang.String attrName, java.lang.String mgName) Get the next long number of an Instance Attribute.
java.lang.String	getNextVersion(InstanceElement instElem, java.util.Hashtable constants, java.lang.String pattern) Get the next version number of an Instance Element.
java.lang.String	getNextVersionGlobal(InstanceElement instElem, java.util.Hashtable constants, java.lang.String pattern) Get the next version number of an Instance Element.
java.lang.String	getPointValue(InstanceElement instElem, java.util.Hashtable constants, java.lang.String meaName, java.lang.String reqMeaQtyName, java.lang.String knownMeaQtyName, java.lang.String value) Get a value from a submatrix.
java.lang.String	getUnmappedName(InstanceElement instElem, java.util.Hashtable constants) If a mapping of measurement quantity names is done this rule gets the name as it was before it was mapped.
java.lang.String	getValue(InstanceElement instElem, java.util.Hashtable constants, java.lang.String meaName, java.lang.String meaQtyName, java.lang.String point) Get a value from a submatrix.
java.lang.String	getValueFromLC(InstanceElement instElem, java.util.Hashtable constants, java.lang.String point, java.lang.String meaName, java.lang.String types) Get a value from a submatrix and store it as attribute.
java.lang.String	mapDatatypes(InstanceElement instElem, java.util.Hashtable constants, java.lang.String qtyName, java.lang.String dataType) Correct wrong datatypes.
java.lang.String	max(InstanceElement instElem, java.util.Hashtable constants, java.lang.String arg1, java.lang.String arg2) Returns the maximum of the two values.
java.lang.String	min(InstanceElement instElem, java.util.Hashtable constants, java.lang.String arg1, java.lang.String arg2) Returns the minimum of the two values.
java.lang.String	replaceAll(InstanceElement instElem, java.util.Hashtable constants, java.lang.String str, java.lang.String sea, java.lang.String rep) Replace characters in a string All single charachters specified in sea are replaced with the string "rep".
java.lang.String	setInReplaceMode(InstanceElement instElem, java.util.Hashtable constants, java.lang.String str) Returns the String "str" if the insert mode is "R" or "N".
java.lang.String	simpleCalc(InstanceElement instElem, java.util.Hashtable constants, java.lang.String arg1, java.lang.String oper, java.lang.String arg2) Perform a simple calculation with two arguments.
java.lang.String	simpleCalc(InstanceElement instElem, java.util.Hashtable constants, java.lang.String arg1, java.lang.String oper, java.lang.String arg2, java.lang.String format)
java.lang.String	substring(InstanceElement instElem, java.util.Hashtable constants, java.lang.String str, java.lang.String start, java.lang.String end) Return a substring of the given string
java.lang.String	toLower(InstanceElement instElem, java.util.Hashtable constants, java.lang.String str) Convert all characters in a String to lower case
java.lang.String	toUpper(InstanceElement instElem, java.util.Hashtable constants, java.lang.String str) Convert all characters in a String to upper case
java.lang.String	trim(InstanceElement instElem, java.util.Hashtable constants, java.lang.String str) Trim whitespace at beginning and end of a string

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonRules

public CommonRules()

Create a new Rules object.

Method Detail

getFromAny

public java.lang.String getFromAny(InstanceElement instElem,
                          java.util.Hashtable constants,
                          java.lang.String applElem,
                          java.lang.String requestedAttr,
                          java.lang.String searchAttr,
                          java.lang.String searchString)

Get an attribute of the instance matching the search criteria. Search for an instance of applElem whose attribute searchAttr equals searchString. If an instance is found return the value of attribute requestedAttr.

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

applElem - Name of application element

requestedAttr - Attribute we are looking for

searchAttr - Search attribute

searchString - Value of search attribute

Returns:

Value of requestedAttr; null if instance is not found.

getByName

public java.lang.String getByName(InstanceElement instElem,
                         java.util.Hashtable constants,
                         java.lang.String aeName,
                         java.lang.String ieName)

Get an instance of an application element by its name.

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

aeName - Name of application element

ieName - Name of instance element

Returns:

id of the found instance element. 0 if it was not found.

replaceAll

public java.lang.String replaceAll(InstanceElement instElem,
                          java.util.Hashtable constants,
                          java.lang.String str,
                          java.lang.String sea,
                          java.lang.String rep)

Replace characters in a string All single charachters specified in sea are replaced with the string "rep".

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

str - The string where the characters are replaced

sea - The search characters

rep - * The replacement string

Returns:

String with replaced characters.

simpleCalc

public java.lang.String simpleCalc(InstanceElement instElem,
                          java.util.Hashtable constants,
                          java.lang.String arg1,
                          java.lang.String oper,
                          java.lang.String arg2)

Perform a simple calculation with two arguments. All Arguments must be parsable as double values and all calculations are done with values of datatype double

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

arg1 - The first argument

oper - The Operator (+, -, *, /)

arg2 - The second Operator

format - The format of the result.

Returns:

simpleCalc

public java.lang.String simpleCalc(InstanceElement instElem,
                          java.util.Hashtable constants,
                          java.lang.String arg1,
                          java.lang.String oper,
                          java.lang.String arg2,
                          java.lang.String format)

toUpper

public java.lang.String toUpper(InstanceElement instElem,
                       java.util.Hashtable constants,
                       java.lang.String str)

Convert all characters in a String to upper case

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

str - The string to convert

Returns:

String with all uppercase characters.

max

public java.lang.String max(InstanceElement instElem,
                   java.util.Hashtable constants,
                   java.lang.String arg1,
                   java.lang.String arg2)

Returns the maximum of the two values. The values are parsed and compared as Doubles

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

arg1 - The first argument

arg2 - The second argument

Returns:

The maximum of the two arguments

min

public java.lang.String min(InstanceElement instElem,
                   java.util.Hashtable constants,
                   java.lang.String arg1,
                   java.lang.String arg2)

Returns the minimum of the two values. The values are parsed and compared as Doubles

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

arg1 - The first argument

arg2 - The second argument

Returns:

The minimum of the two arguments

toLower

public java.lang.String toLower(InstanceElement instElem,
                       java.util.Hashtable constants,
                       java.lang.String str)

Convert all characters in a String to lower case

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

str - The string to convert

Returns:

String with all lowercase characters.

connectStrings

public java.lang.String connectStrings(InstanceElement instElem,
                              java.util.Hashtable constants,
                              java.lang.String p1,
                              java.lang.String p2)

Connect two Strings.

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

p1 - First part of string to connect

p2 - Second part of string to connect

Returns:

The connected string

connectStrings

public java.lang.String connectStrings(InstanceElement instElem,
                              java.util.Hashtable constants,
                              java.lang.String p1,
                              java.lang.String p2,
                              java.lang.String p3)

Connect three strings

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

p1 - First part of string to connect

p2 - Second part of string to connect

p3 - Third part of string to connect

Returns:

The connected string

connectStrings

public java.lang.String connectStrings(InstanceElement instElem,
                              java.util.Hashtable constants,
                              java.lang.String p1,
                              java.lang.String p2,
                              java.lang.String p3,
                              java.lang.String p4)

Connect four Strings

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

p1 - First part of string to connect

p2 - Second part of string to connect

p3 - Third part of string to connect

p4 - Fourth part of string to connect

Returns:

The connected string

connectStrings

public java.lang.String connectStrings(InstanceElement instElem,
                              java.util.Hashtable constants,
                              java.lang.String p1,
                              java.lang.String p2,
                              java.lang.String p3,
                              java.lang.String p4,
                              java.lang.String p5)

Connect five Strings

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

p1 - First part of string to connect

p2 - Second part of string to connect

p3 - Third part of string to connect

p4 - Fourth part of string to connect

p5 - Fifth part of string to connect

Returns:

The connected string

connectStrings

public java.lang.String connectStrings(InstanceElement instElem,
                              java.util.Hashtable constants,
                              java.lang.String p1,
                              java.lang.String p2,
                              java.lang.String p3,
                              java.lang.String p4,
                              java.lang.String p5,
                              java.lang.String p6)

Connect six Strings

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

p1 - First part of string to connect

p2 - Second part of string to connect

p3 - Third part of string to connect

p4 - Fourth part of string to connect

p5 - Fifth part of string to connect

p6 - Sixth part of string to connect

Returns:

The connected string

connectStrings

public java.lang.String connectStrings(InstanceElement instElem,
                              java.util.Hashtable constants,
                              java.lang.String p1,
                              java.lang.String p2,
                              java.lang.String p3,
                              java.lang.String p4,
                              java.lang.String p5,
                              java.lang.String p6,
                              java.lang.String p7)

Connect seven Strings

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

p1 - First part of string to connect

p2 - Second part of string to connect

p3 - Third part of string to connect

p4 - Fourth part of string to connect

p5 - Fifth part of string to connect

p6 - Sixth part of string to connect

p7 - Seventh part of string to connect

Returns:

The connected string

connectStrings

public java.lang.String connectStrings(InstanceElement instElem,
                              java.util.Hashtable constants,
                              java.lang.String p1,
                              java.lang.String p2,
                              java.lang.String p3,
                              java.lang.String p4,
                              java.lang.String p5,
                              java.lang.String p6,
                              java.lang.String p7,
                              java.lang.String p8)

Connect eight Strings

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

p1 - First part of string to connect

p2 - Second part of string to connect

p3 - Third part of string to connect

p4 - Fourth part of string to connect

p5 - Fifth part of string to connect

p6 - Sixth part of string to connect

p7 - Seventh part of string to connect

p8 - Eight part of string to connect

Returns:

The connected string

substring

public java.lang.String substring(InstanceElement instElem,
                         java.util.Hashtable constants,
                         java.lang.String str,
                         java.lang.String start,
                         java.lang.String end)

Return a substring of the given string

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

str - Original String

start - Position of first character in str to be returned (counting starts with 0)

end - Position of last character in str to be returned

Returns:

The substring (str[begin:end])

buildNumericVersion

public java.lang.String buildNumericVersion(InstanceElement instElem,
                                   java.util.Hashtable constants,
                                   java.lang.String meaName)

Build the numeric version for concerto. Usually the Version string is the name of the measurement. If it has a numeric extension (like .012) the number is used as the numeric version. Otherwise it is set to 1. There is no guarantee that the numeric version is unique!

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

meaName - The version string

Returns:

The numeric version

getMeaVersion

public java.lang.String getMeaVersion(InstanceElement instElem,
                             java.util.Hashtable constants,
                             java.lang.String dummy)

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

pattern - The pattern for the version string. The numeric part can specified as %000d or %###d. The number of "0" or "#" specifies the minimal filed width. If "0" is used the number is padded with leading zeros, if "#" is used it is padded with leading blanks. An empty string leads to an integer without padding. Example: Test-%00000d" leads to Test-00012.

Returns:

The Version string.

getNextVersionGlobal

public java.lang.String getNextVersionGlobal(InstanceElement instElem,
                                    java.util.Hashtable constants,
                                    java.lang.String pattern)

Get the next version number of an Instance Element. The intention of this method is to provide a unique version numbering of instances for the importtool. It works only on the base attribute "Version" of an instance element. If the instance already has a version set it is not changed. The version can be any string pattern that contains a long value. The pattern that is used to get and set the numeric part of the version string can be specified with a parameter. If nothing is specified a simple long value is used. The method gets all instances with the same name as the given instance. Next the versions are read from the instances and then sorted. The highest version is increased by 1 and written to the result with the specified pattern. There is a special handling for Testruns created in the PAS system. The Testrun name already contains the correct version so it must not be calculated. PAS-Testruns are recognized by the constant MRTYP.

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

pattern - The pattern for the version string. The numeric part can specified as %000d or %###d. The number of "0" or "#" specifies the minimal filed width. If "0" is used the number is padded with leading zeros, if "#" is used it is padded with leading blanks. An empty string leads to an integer without padding. Example: Test-%00000d" leads to Test-00012.

Returns:

The Version string.

getNextLongVersion

public java.lang.String getNextLongVersion(InstanceElement instElem,
                                  java.util.Hashtable constants,
                                  java.lang.String attrName,
                                  java.lang.String mgName)

Get the next long number of an Instance Attribute. The intention of this method is to provide a unique version numbering of instances for the importtool. It works only on attributes of datatype "long". If the attribute already has a value not equal to 0 it is not changed! The method gets the father of the instance and the lists all children with the same name. Next the attributes values are read from the children and then sorted. The highest number is increased by 1 and written to the result with the specified pattern.

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

mgName - Name of Measurement Group (no more used, only present for compatibility)

attrName - The name of the version attribute.

Returns:

The number as a string.

getValue

public java.lang.String getValue(InstanceElement instElem,
                        java.util.Hashtable constants,
                        java.lang.String meaName,
                        java.lang.String meaQtyName,
                        java.lang.String point)

Get a value from a submatrix.

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

meaName - Name of measurement ("*" for all measurements)

meaQtyName - Name of mesurement Quantity

point - Measurement point to read ("last" or an integer value). First point is 1

Returns:

The value of "MeaQtyName" at row "point"

trim

public java.lang.String trim(InstanceElement instElem,
                    java.util.Hashtable constants,
                    java.lang.String str)

Trim whitespace at beginning and end of a string

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

str - The string to trim

Returns:

The trimmed string.

setInReplaceMode

public java.lang.String setInReplaceMode(InstanceElement instElem,
                                java.util.Hashtable constants,
                                java.lang.String str)

Returns the String "str" if the insert mode is "R" or "N". Otherwise null is returned

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

str - The string to return in mode "N" or "R"

Returns:

str in insert mode "R" or "N", otherwise null

getPointValue

public java.lang.String getPointValue(InstanceElement instElem,
                             java.util.Hashtable constants,
                             java.lang.String meaName,
                             java.lang.String reqMeaQtyName,
                             java.lang.String knownMeaQtyName,
                             java.lang.String value)

Get a value from a submatrix. Get value of column "reqMeaQtyName" where "value" of column "knownMeaQtyName" equals "vaule" from measurement "meaName"

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

meaName - Name of measurement ("*" for all measurements)

reqMeaQtyName - Name of requested measurement quantity

knownMeaQtyName - Name of reference measurement quantity

value - Value of reference measurement quantity we are looking for.

Returns:

The value of "MeaQtyName" at row "point". Null if not found.

mapDatatypes

public java.lang.String mapDatatypes(InstanceElement instElem,
                            java.util.Hashtable constants,
                            java.lang.String qtyName,
                            java.lang.String dataType)

Correct wrong datatypes. If the quantity is named "TIMESTMP" we use datatype "String" instead of the configured "Long"

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

qtyName - Name of quantity

dataType - The default datatype configured for the quantity

Returns:

The datatype.

getValueFromLC

public java.lang.String getValueFromLC(InstanceElement instElem,
                              java.util.Hashtable constants,
                              java.lang.String point,
                              java.lang.String meaName,
                              java.lang.String types)

Get a value from a submatrix and store it as attribute.

Parameters:

instElem - The instance element object that is created or updated (must be of type AoMeasurementQuantity)

constants - Hashtable containing the constants

point - Measurement point to read ("last" or an integer value). First point is 1

meaName - Name of measurement the meq belongs to

types - List of measurement names, separated with blanks. If meaName is found in this list or the list is empty the rule is performed, otherwise nothing is done.

Returns:

The value of "MeaQtyName" at row "point"

getNextVersion

public java.lang.String getNextVersion(InstanceElement instElem,
                              java.util.Hashtable constants,
                              java.lang.String pattern)

Get the next version number of an Instance Element. The intention of this method is to provide a unique version numbering of instances for the importtool. It works only on the base attribute "Version" of an instance element. If the instance already has a version set it is not changed. The version can be any string pattern that contains a long value. The pattern that is used to get and set the numeric part of the version string can be specified with a parameter. If nothing is specified a simple long value is used. The method gets the father of the instance and the lists all children with the same name. Next the versions are read from the children and then sorted. The highest version is increased by 1 and written to the result with the specified pattern. All Version numbers calculated this way are stored in a Hashtable with the asam path of the instance as key. For subsequent calls the version is read from the hashtable and simply increased by 1. This increases performance and is necessary because it can not be guaranteed that the instance for the calculated version is written to the server before the next thread tries to get a new version for the same instance. There is a special handling for Testruns created in the PAS system. The Testrun name already contains the correct version so it must not be calculated. PAS-Testruns are recognized by the constant MRTYP.

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

pattern - The pattern for the version string. The numeric part can specified as %000d or %###d. The number of "0" or "#" specifies the minimal filed width. If "0" is used the number is padded with leading zeros, if "#" is used it is padded with leading blanks. An empty string leads to an integer without padding. Example: Test-%00000d" leads to Test-00012.

Returns:

The Version string.

getUnmappedName

public java.lang.String getUnmappedName(InstanceElement instElem,
                               java.util.Hashtable constants)

If a mapping of measurement quantity names is done this rule gets the name as it was before it was mapped. In case there was no mapping the measuement quantity name is returned.

Parameters:

instElem - The instance element of the measurement quantity

constants - Hashtable containing the constants

Returns:

The measurement quantity name before mapping.

getDescriptionFromValFile

public java.lang.String getDescriptionFromValFile(InstanceElement instElem,
                                         java.util.Hashtable constants,
                                         java.lang.String defValue)

Reads the description for a constant found in a .VAL file. If on description was found the default value specified as a parameter is returned. This rule can only be used during "Create Test" or "Update Test" commands and can only be applied to measurement quantity attributes.

Parameters:

instElem - The instance element object that is created or updated

constants - Hashtable containing the constants

defValue - Default Value, used if no description is found.

Returns:

Description of the constant found in the .val file.