com.highqsoft.moma.rules.ods

Class ElementToRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.ods.ElementToRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

Direct Known Subclasses:

ElementToRuleWithDynamicElementname

public class ElementToRule
extends AbstractSequencerRule

Since:

$Date: 2019/08/28 08:30:10 $ Modification History: $Log: ElementToRule.java,v $ Revision 1.103 2019/08/28 08:30:10 karst Report localcolumn name in case there is a problem with converting the values. Revision 1.102 2019/05/17 14:02:13 markus New property "LogMissingAttributes" to suppress messages about missing attributes in the target model. Revision 1.101 2019/03/13 14:05:41 markus Use longlongVal instead of longlongSeq for Id when local column values are written. Current Avalons have a check for the data type that fails if SVCVAL_SPS is used. Revision 1.100 2018/12/17 15:19:45 karst Add info and fine magges for handling n:m relations. Revision 1.99 2018/11/07 10:04:08 karst In case the units are not loadable, load each unit separate. Revision 1.98 2018/05/29 12:02:13 markus Avoid index out of bound if base attribute name is not available Revision 1.97 2018/04/10 15:40:35 karst getToplevelElementsWithoutVersion loops with max 300 names, otherwise the SQl Statement get to long. Revision 1.96 2018/03/19 19:05:39 markus Check for null attributes in getAttributeUnits() Revision 1.95 2018/03/14 13:42:23 karst Check the line before using to get the units of the attribute (#5641) Revision 1.94 2018/03/05 17:20:22 markus Reduce the number of queries for toplevel elements without version attribute. Speeds up catalog updates. Revision 1.93 2018/02/22 10:46:25 markus Remove flags from local columns to allow writing them in a single SQL. Revision 1.92 2018/01/24 14:10:52 karst Add check for length of one line. Revision 1.91 2018/01/10 14:57:00 karst Implement datatype DS_FLOAT, DS_COMPLEX. Revision 1.90 2017/11/03 10:32:30 karst Get the correct mesenger and check the line is not null. Revision 1.89 2017/10/27 07:59:35 markus Issue 5584: Only the attribute units of the first instance were queried from the target. Missing unit was missing in error message. Revision 1.88 2017/08/31 09:37:05 alex extended documentation Revision 1.87 2017/07/28 14:43:11 karst Add message when there is an error in the character conversion. Revision 1.86 2017/06/29 08:15:44 dieter removed trace output set loglevel to fine Revision 1.85 2017/04/27 08:26:48 markus Issue 5393: Fixed ArrayOutOfBoundIndex if there are attributes with units and not all instances have the same number of attributes. Revision 1.84 2017/04/06 13:30:20 adil update copyright. Revision 1.83 2016/12/28 17:01:46 karst Add argument NoLinkForElements. Revision 1.82 2016/07/01 11:04:49 markus Use all measurements when checking the attribute units, not only the first one. Revision 1.81 2016/06/08 01:46:21 florian Update Documentation Revision 1.80 2016/02/05 14:57:49 karst Reduce the messages. Revision 1.79 2015/09/22 16:26:19 karst Minor changes. Revision 1.78 2015/09/16 15:25:44 karst Less messenges on INFO level. Revision 1.77 2015/07/30 11:45:22 dieter moved some code into new methods for reusing it in subclasses Revision 1.76 2015/06/01 07:11:46 karst Get the parent relation name and parent element Id without checking the input data set. Revision 1.75 2015/05/20 13:06:29 karst Update Copyrights to current. Revision 1.74 2015/04/30 12:47:23 karst Add check / switch for missing name and missing parent. Revision 1.73 2015/01/14 11:28:29 karst Minor changes. Revision 1.72 2014/11/18 14:30:57 karst Correct error output. Revision 1.71 2014/11/13 08:19:26 markus Support data types DT_BYTE and DT_LONGLONG when writing local column values Revision 1.70 2014/11/04 12:59:47 karst Throw an exception when there is no name to search for. Revision 1.69 2014/10/27 07:46:19 karst Correct the error messages. Revision 1.68 2014/09/08 08:54:30 markus Fix for Issue 4552 After removing the Id attribute from the values to insert the attribute units were partially out of order. Revision 1.67 2014/08/27 12:02:42 karst Check the number of attributes in the result set before usages. Revision 1.66 2014/08/14 16:05:35 karst Add check of the element name. Revision 1.65 2014/08/13 13:29:23 karst Minor changes, add more error messages. Revision 1.64 2014/08/06 12:48:33 karst Add feature to remember any other value as key for the target element Id as the Id from the source. Revision 1.63 2014/07/31 08:13:51 karst Check if the MEQ is found in the target for the localcolumn to get the datatype of the values. Prefend NULL-Pointer exception but thrown a RuleException. Revision 1.62 2014/07/22 08:13:49 karst Minor checks and output added. Revision 1.61 2014/07/08 19:58:42 markus Avoid NullPointerException in getAttributeUnit() Revision 1.60 2014/06/26 09:33:28 markus Make sure the cached measurement quantity datatype has always the id of the target meq as key. Revision 1.59 2014/03/14 15:22:12 karst Add property SplitNMRelationValue Revision 1.58 2014/03/08 20:49:49 markus Process attributes with units correct Revision 1.57 2014/03/07 16:16:24 karst Catch NumberFormatException and make a RuleException of it. Revision 1.56 2013/08/12 21:33:06 markus Added the errorReasonProperty Revision 1.55 2013/08/08 08:44:25 markus Use ApplicationElement.RemoveInstance in mode REPLACE in recursive mode to get the children deleted as well. ao_file_children are removed before because they are currently not removed by ApplicationElement.RemoveInstance. Revision 1.54 2013/08/05 20:30:04 markus Handle an empty version string Revision 1.53 2013/07/30 18:51:49 markus Added the property AbortOnMissingTargetAttribute. Enable the update of a measurement when there were no local columns before. Revision 1.52 2013/03/12 15:15:24 karst Checks the attributes are not NULL. Revision 1.51 2013/01/03 09:51:52 karst Update copyright to 2013. Revision 1.50 2012/11/20 09:24:07 markus Changed all Exceptions with message "Error.AsamOdsError" to use OdsHelper.toString(exception) instead of exception.getMessage(). Revision 1.49 2012/09/27 19:30:48 markus Bugfix: Local Columns of type DT_BYTESTR were not handled correctly when there were more than 2 values Revision 1.48 2012/07/22 19:48:06 markus Check for null elements in nvu Revision 1.47 2012/07/03 15:11:38 markus Check if flags string is empty before calling the parser Revision 1.46 2012/05/29 17:52:47 markus Better documentation for mode "replace" Revision 1.45 2012/05/29 11:26:32 markus Added mode "replace". removes and reinserts the element. Revision 1.44 2012/04/16 07:42:08 markus Remove the nvu entires of LC values after they are copied. This saves about 50% of memory when writing local columns. Revision 1.43 2012/01/18 12:11:34 markus Use meq id instead of name to cache the datatypes. Had to be changed because of atf files containing the same channel name with different data type in different measuerments Revision 1.42 2012/01/04 08:17:07 karst Update copyright to 2012. Revision 1.41 2011/11/20 18:51:19 markus Corrected creation of n:m relations in mode "no_check" Revision 1.40 2011/09/18 11:40:49 markus Bugfix: Mode create N:M relations did not work in mode "update" if there was a mix of new and existing elements in the source Revision 1.39 2011/09/13 13:12:44 markus Corrected parsing of flags Revision 1.38 2011/05/09 16:54:26 markus Parse the integer datatypes with a format string to avoid exceptions when they contain a decimal point. Revision 1.37 2011/03/27 10:38:00 markus Bugfix in handling of Version with Datatype DT_LONG Revision 1.36 2011/03/09 17:30:26 markus Added the property "VersionIsLong" to allow writing to a Santorin Server. Ignore Errorcode AO_NOT_FOUND in exceptions caused by a query. Revision 1.35 2011/02/25 16:09:31 karst Add some checks to prefend java exceptions. Revision 1.34 2011/02/22 13:44:37 karst Update header comment for documentation. Revision 1.33 2011/01/30 12:26:31 markus Removed the message when N:M relations are created. Revision 1.32 2011/01/06 09:48:25 karst Some changes added. Revision 1.31 2011/01/05 17:24:58 markus Handling of flags fixed Revision 1.30 2011/01/05 09:10:35 karst Update copyright header to 2011 Revision 1.29 2010/12/20 14:38:19 karst Determine the type of the element using the odscache. Revision 1.28 2010/12/09 10:10:00 karst Use the correct index for the update. Revision 1.27 2010/11/17 13:03:05 karst Prefend array out of range index when the Id is not found. Revision 1.26 2010/11/05 10:29:55 karst Make the methods protected for inheritence. Revision 1.25 2010/07/07 20:52:26 markus Fixed wrong String[] in call to removeValueAttributes. Revision 1.24 2010/06/29 13:45:14 karst Reorganize import. Revision 1.23 2010/06/14 11:26:51 karst Correct query on elements with version. Revision 1.22 2010/06/10 15:57:53 markus Bugfix: Existing Toplevel Elements were not found in write mode IGNORE and UPDATE Revision 1.21 2010/05/05 18:48:44 markus Performance Optimization 1: During check if an instance exists all children of its parent are read at once and cached. This reduces database load especially for Meq and LC. Performance Optimization 2: When Local Column values are set the local columns are now grouped by datatype and updated at once instead of every single LC Revision 1.20 2010/03/08 16:15:33 andy When tracing the setValue method, check that the nvu is not null. Revision 1.19 2010/02/03 09:15:53 markus Changed addToValuesArray to add only values that have the valid flag set. Revision 1.18 2010/01/24 20:44:24 markus Rollback to Release 1.16. The changes didn't work with corba targets because null strings cannot be processed. Revision 1.17 2010/01/11 12:09:57 markus Check if flag is valid in addToValuesArray Do not take version attribute into account if the value is empty Revision 1.16 2010/01/11 07:56:21 karst Update header comment to current Revision 1.15 2009/12/01 10:01:42 markus Changed the split() of String and Date values to enable empty Strings Revision 1.14 2009/09/02 07:46:13 alex write values only if more than 1 unit sequence (IDs) Revision 1.13 2009/08/31 10:09:05 karst Update header comment. Revision 1.12 2009/06/30 08:44:45 charly Documentation revised. Revision 1.11 2009/03/23 12:49:05 markus Check if there are N:M relations at all before trying to create them. Revision 1.10 2009/03/10 14:09:01 markus Prevent from null pointer exception in addToValuesArray Revision 1.9 2009/03/10 13:42:36 markus Bugfix in create N:M relations. Did not work before. Revision 1.8 2009/01/19 20:27:26 markus Additional init() Method for calls from MeasurementToRule Check if generation_parameters are separated with comma or whitespace (difference between ODS data source and XATF source). Revision 1.7 2009/01/09 10:16:33 markus Corrected the handling of DT_BYTESTR in lcSetValues Revision 1.6 2009/01/05 09:38:43 karst Modify copyright to 2009 Revision 1.5 2008/12/09 11:26:33 markus Read the messages from com/highqsoft/moma/rules during init() Corrected the messages Revision 1.4 2008/12/03 21:49:44 markus Write lcValues as DS_BYTESTR when Datatype is DT_BYTESTR Revision 1.3 2008/12/03 11:46:31 markus Added DT_BYTESTR to setLcValues() Revision 1.2 2008/11/25 11:52:21 markus Added the changes from the Bosch/PLCD - project Revision 1.1 2008/11/20 10:03:44 markus Initial Release. Not yet documented the correct way!

Version:

$Revision: 1.103 $

Author:

Karst Schaap

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	abortOnMissingTargetAttr
protected java.lang.String	attributeBaseName
protected java.lang.String[]	attrNames
protected java.util.Hashtable<java.lang.String,java.util.Hashtable<java.lang.String,T_LONGLONG>>	elemCache Hashtable containing the cached elements.
protected java.lang.String	elementName
protected java.lang.String	errorReasonProperty
protected boolean	ignoreMissingName
protected boolean	ignoreMissingParent
protected int	insertState
protected int	IS_ABORT
protected int	IS_IGNORE
protected int	IS_NOCHECK
protected int	IS_REPLACE
protected int	IS_UPDATE
protected boolean	logExisting
protected boolean	logMissingAttributes
protected java.lang.String[]	noLinkForElements
protected ODSCache	odsCache
protected boolean	rememberInstancesId
protected boolean	splitNM
protected boolean	versionIsLong

Fields inherited from class com.highqsoft.xsd.AbstractSequencerRule

cleanAfterGet, localNVU

Fields inherited from class com.highqsoft.xsd.AbstractRule

loggerName, postMethods, preMethods, sessionRef

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
ElementToRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addResToFound(java.util.Hashtable<java.lang.String,T_LONGLONG> foundIds, ElemResultSet[] res)
protected boolean	addToValuesArray(NameValueUnit[] nvu, java.lang.String[] names, java.lang.String[][] values, int ieIndex) Add the attribute values of an instance element to the values[][] that holds the attributes to write.
protected void	cacheMeqDatatypes(java.lang.String[] names, java.lang.String[][] values, boolean idIsFromTarget) Get name and datatype of each measurement quantity and store it in the odsCache
protected void	checkElementName()
protected T_LONGLONG	checkIds(QueryStructure qs, java.lang.String idName, NameValueUnit[] nvu) Query an instance by its id.
protected AIDNameValueSeqUnitId[]	createAIDNameValueSeqUnitId(java.lang.String[] names, java.lang.String[][] values, T_LONGLONG[] attrUnits) Convert the String[][] values to an AIDNameValueSeqUnitId[].
protected AIDNameValueSeqUnitId	createAIDNameValueSeqUnitId(java.lang.String name, T_LONGLONG aid) Helper to create an AIDNameValueSeqUnitId an
protected void	createNMrelations(ElemId[] newIds, NameValueUnit[][] nvu)
void	doUpdate(T_LONGLONG[] idsForUpdate, short[][] flagsForUpdate, AIDNameValueSeqUnitId values) Performs the update of local column values
void	execute() The execute method, nothing to do.
protected int	firstIndexOf(java.lang.String[] str, java.lang.String searchString) Find the first index in a string array that contains the searchString
protected int	getAttributeIndex(NameValueUnit[] attributes, java.lang.String attrName) Get the index on an attribute.
protected T_LONGLONG	getIdsByName(java.lang.String idName, java.lang.String nameName, java.lang.String versionName, NameValueUnit[] nvu) Perform a query to get instances by their name.
protected T_LONGLONG	getParentAid() Get the Id of the parent application element.
protected java.lang.String	getParentName() Get the Name of the parent Application Element
protected java.util.Hashtable<java.lang.String,T_LONGLONG>	getToplevelElementsWithoutVersion(java.lang.String idName, java.lang.String nameName, java.lang.String[] names) Perform a query to get instances by their name.
protected java.lang.String[]	getUsedAttributeNames(NameValueUnit[][] nvu) Look at the values which target attribute names are used in the source.
protected java.lang.String[]	getUsedNMRelationNames(NameValueUnit[][] nvu) Look at the values which target N to M relation names are used in the source.
void	init() The initialization of the rule.
void	init(java.lang.String elementName, ODSCache odsCache, java.lang.String insertMode, boolean rememberInstances, boolean logExisting, boolean versionIsLong, boolean abortOnMissingTargetAttr, java.lang.String errorReasonProperty)
void	init(java.lang.String elementName, ODSCache odsCache, java.lang.String insertMode, boolean rememberInstances, boolean logExisting, boolean versionIsLong, boolean abortOnMissingTargetAttr, java.lang.String errorReasonProperty, boolean logMissingAttributes)
void	init(java.lang.String elementName, ODSCache odsCache, java.lang.String insertMode, boolean rememberInstances, boolean logExisting, boolean versionIsLong, boolean abortOnMissingTargetAttr, java.lang.String errorReasonProperty, java.lang.String attributeBaseName, boolean logMissingAttributes)
protected QueryStructure	prepareQueryStructureById(java.lang.String idName) Prepare a query structure to get instances by id.
protected QueryStructure	prepareQueryStructureByName(java.lang.String idName, java.lang.String nameName, java.lang.String versionName, java.lang.String nameValue, java.lang.String versionValue) Prepare a query structure to get instances by name and version (if version attribute exists).
protected QueryStructure	prepareQueryStructureByParent(java.lang.String idName, java.lang.String nameName, java.lang.String versionName, ElemId parentId) Prepare a query structure to select Id, Name and (optionally) version of all instances within a parent.
protected QueryStructure	prepareQueryStructureForCatalogs(java.lang.String idName, java.lang.String nameName, java.lang.String[] names) Prepare a query structure to get instances by an array of names.
protected java.lang.String[][]	removeEmptyEntries(java.lang.String[][] values, int length) Remove null values from the values[][]
protected java.lang.String[][]	removeIdAttribute(java.lang.String[] names, java.lang.String[][] valuesToInsert) Remove the id column from the values[][]
protected java.lang.String[]	removeIdAttributeName(java.lang.String[] names) Remove the id from the attribute names
protected java.lang.String[]	removeValueAttributeNames(java.lang.String[] names) Remove the names of the generation_parameter and values attributes from the array of attribute names.
protected java.lang.String[][]	removeValueAttributes(java.lang.String[] names, java.lang.String[][] values) Remove the base attributes values and generation_parameters from the values array.
void	setValue(NameValueUnit[][] nvu) Set the value.
void	terminate() The terminat method, reset the local variables.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

getValue

Methods inherited from class com.highqsoft.xsd.AbstractRule

execute, executePostMethods, executePreMethods, getAoSessionFromContextWithSessionRef, getId, getOdsCache, getPointTo, getSessionRef, getType, isPedantic, setGathermode, setId, setPointTo, setPostMethods, setPreMethods, setSessionRef, setType, toString, toString, toString

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Field Detail

elementName

protected java.lang.String elementName

odsCache

protected ODSCache odsCache

noLinkForElements

protected java.lang.String[] noLinkForElements

elemCache

protected java.util.Hashtable<java.lang.String,java.util.Hashtable<java.lang.String,T_LONGLONG>> elemCache

Hashtable containing the cached elements. The hashtable is used if elements are searched by name and there is a relation to a parent. In this case all elemtents within the parents a queried at once and stored in the hashtable. This reduces the number of database calls especially for a large amount of Meqs and LCs in a measurement. The key of the hashtable is the parents id as a string. The value is a second hashtable containing the childs name as a string and its id as a T_LONGLONG.

IS_ABORT

protected int IS_ABORT

IS_IGNORE

protected int IS_IGNORE

IS_NOCHECK

protected int IS_NOCHECK

IS_UPDATE

protected int IS_UPDATE

IS_REPLACE

protected int IS_REPLACE

insertState

protected int insertState

rememberInstancesId

protected boolean rememberInstancesId

attributeBaseName

protected java.lang.String attributeBaseName

logExisting

protected boolean logExisting

logMissingAttributes

protected boolean logMissingAttributes

splitNM

protected boolean splitNM

versionIsLong

protected boolean versionIsLong

ignoreMissingParent

protected boolean ignoreMissingParent

ignoreMissingName

protected boolean ignoreMissingName

attrNames

protected java.lang.String[] attrNames

abortOnMissingTargetAttr

protected boolean abortOnMissingTargetAttr

errorReasonProperty

protected java.lang.String errorReasonProperty

Constructor Detail

ElementToRule

public ElementToRule()

Method Detail

getUsedAttributeNames

protected java.lang.String[] getUsedAttributeNames(NameValueUnit[][] nvu)
                                            throws RuleException

Look at the values which target attribute names are used in the source.

Parameters:

nvu - 2-dimensional Array of Values. First index is the instance element, second index is the attribute.

Returns:

String Array with all used attribute names

Throws:

RuleException

getIdsByName

protected T_LONGLONG getIdsByName(java.lang.String idName,
                      java.lang.String nameName,
                      java.lang.String versionName,
                      NameValueUnit[] nvu)
                           throws RuleException

Perform a query to get instances by their name. To get better performance all children of the instances parent are queried at once if the application element has a parent relation. The instances are cached because often all instances within a parent element are required (especially Local Columns and Measurement Quantities).

Parameters:

idName - Name of Id attribute

nameName - Name of name attribute

versionName - Name of version attribute

nvu - NameValueUnit[][] holding the instances and their attributes

Returns:

The id found or null if no element with this name exists.

Throws:

RuleException

addResToFound

protected void addResToFound(java.util.Hashtable<java.lang.String,T_LONGLONG> foundIds,
                 ElemResultSet[] res)
                      throws AoException

Throws:

AoException

getToplevelElementsWithoutVersion

protected java.util.Hashtable<java.lang.String,T_LONGLONG> getToplevelElementsWithoutVersion(java.lang.String idName,
                                                                                 java.lang.String nameName,
                                                                                 java.lang.String[] names)
                                                                                      throws RuleException

Perform a query to get instances by their name. To get better performance all children of the instances parent are queried at once if the application element has a parent relation. The instances are cached because often all instances within a parent element are required (especially Local Columns and Measurement Quantities).

Parameters:

idName - Name of Id attribute

nameName - Name of name attribute

versionName - Name of version attribute

names - NameValueUnit[][] holding the instances and their attributes

versions -

Returns:

The id found or null if no element with this name exists.

Throws:

RuleException

checkIds

protected T_LONGLONG checkIds(QueryStructure qs,
                  java.lang.String idName,
                  NameValueUnit[] nvu)
                       throws RuleException

Query an instance by its id.

Parameters:

qs - The query structure

idName - Name of the id attribute

nvu - NameValueUnit[][] containing the instances and attributes

Returns:

The id of the found instance, null if it doesn't exist.

Throws:

RuleException

getParentName

protected java.lang.String getParentName()

Get the Name of the parent Application Element

Returns:

The name of the parent application element

getParentAid

protected T_LONGLONG getParentAid()

Get the Id of the parent application element.

Returns:

The name of the parent application element

prepareQueryStructureByName

protected QueryStructure prepareQueryStructureByName(java.lang.String idName,
                                         java.lang.String nameName,
                                         java.lang.String versionName,
                                         java.lang.String nameValue,
                                         java.lang.String versionValue)
                                              throws RuleException

Prepare a query structure to get instances by name and version (if version attribute exists).

Parameters:

idName - Name of id attribute

nameName - Name of name attribute

versionName - Name of version attribute

nameValue - Name to search

versionValue - Value to search

Returns:

The query structure

Throws:

RuleException

prepareQueryStructureForCatalogs

protected QueryStructure prepareQueryStructureForCatalogs(java.lang.String idName,
                                              java.lang.String nameName,
                                              java.lang.String[] names)
                                                   throws RuleException

Prepare a query structure to get instances by an array of names.

Parameters:

idName - Name of id attribute

nameName - Name of name attribute

names - Array of names to search

Returns:

The query structure

Throws:

RuleException

prepareQueryStructureById

protected QueryStructure prepareQueryStructureById(java.lang.String idName)

Prepare a query structure to get instances by id.

Parameters:

idName - Name of id attribute

Returns:

The query structure

removeEmptyEntries

protected java.lang.String[][] removeEmptyEntries(java.lang.String[][] values,
                                      int length)

Remove null values from the values[][]

Parameters:

values - The String[][] containing the attribute values for all instances

length - The number of entries in the values[][]

Returns:

A values[][] containing length instances

doUpdate

public void doUpdate(T_LONGLONG[] idsForUpdate,
            short[][] flagsForUpdate,
            AIDNameValueSeqUnitId values)
              throws RuleException

Performs the update of local column values

Parameters:

idsForUpdate - The ids of the local columns to update

flagsForUpdate - The flags to update

values - The values to update

Throws:

RuleException

AoException

createAIDNameValueSeqUnitId

protected AIDNameValueSeqUnitId createAIDNameValueSeqUnitId(java.lang.String name,
                                                T_LONGLONG aid)

Helper to create an AIDNameValueSeqUnitId an

Parameters:

name - The attribute name

aid - The application element id

Returns:

The AIDNameValueSeqUnitId structure

getAttributeIndex

protected int getAttributeIndex(NameValueUnit[] attributes,
                    java.lang.String attrName)

Get the index on an attribute.

Parameters:

attributes - The NameValueUnit[] of attributes on an instance

attrName - The name of the attribute we look for

Returns:

The index of the attribute in the attributes array. An index <0 means "not found".

setValue

public void setValue(NameValueUnit[][] nvu)
              throws RuleException

Set the value.

Parameters:

nvu - - the attribute values of the instances of the element of the rule.

Throws:

RuleException

See Also:

RuleIF.setValue(org.asam.ods.NameValueUnit[][])

removeIdAttributeName

protected java.lang.String[] removeIdAttributeName(java.lang.String[] names)

Remove the id from the attribute names

Parameters:

names - Array of attribute names

Returns:

The names[] without the id attribute

removeIdAttribute

protected java.lang.String[][] removeIdAttribute(java.lang.String[] names,
                                     java.lang.String[][] valuesToInsert)

Remove the id column from the values[][]

Parameters:

names - Array of column names

valuesToInsert - The values[][]

Returns:

The values[][] without the id column

createNMrelations

protected void createNMrelations(ElemId[] newIds,
                     NameValueUnit[][] nvu)
                          throws RuleException

Throws:

RuleException

removeValueAttributeNames

protected java.lang.String[] removeValueAttributeNames(java.lang.String[] names)

Remove the names of the generation_parameter and values attributes from the array of attribute names.

Parameters:

names - The array of attribute names

Returns:

createAIDNameValueSeqUnitId

protected AIDNameValueSeqUnitId[] createAIDNameValueSeqUnitId(java.lang.String[] names,
                                                  java.lang.String[][] values,
                                                  T_LONGLONG[] attrUnits)
                                                       throws RuleException

Convert the String[][] values to an AIDNameValueSeqUnitId[].

Parameters:

names - The array containing the attribute names

values - The array containing the attribute values for the instances

attrUnits2 -

Returns:

The AIDNameValueSeqUnitId[] used in insertInstances

Throws:

RuleException

removeValueAttributes

protected java.lang.String[][] removeValueAttributes(java.lang.String[] names,
                                         java.lang.String[][] values)

Remove the base attributes values and generation_parameters from the values array. Map the sequence_representation from XATF to ODS notation.

Parameters:

names -

values -

Returns:

firstIndexOf

protected int firstIndexOf(java.lang.String[] str,
               java.lang.String searchString)

Find the first index in a string array that contains the searchString

Parameters:

str - The string array

searchString - The search string

Returns:

The first index that contains searchString. If the string was not found or the search string is null -1 is returned.

cacheMeqDatatypes

protected void cacheMeqDatatypes(java.lang.String[] names,
                     java.lang.String[][] values,
                     boolean idIsFromTarget)
                          throws RuleException

Get name and datatype of each measurement quantity and store it in the odsCache

Parameters:

names - The array containing the attribute names

values - The array containing the attribute values for each instance.

idIsFromTarget - TODO

Throws:

RuleException

addToValuesArray

protected boolean addToValuesArray(NameValueUnit[] nvu,
                       java.lang.String[] names,
                       java.lang.String[][] values,
                       int ieIndex)

Add the attribute values of an instance element to the values[][] that holds the attributes to write.

Parameters:

nvu - NameValueUnit[] with the attributes of the instance.

names - Array of Strings with attribute names.

values - Two dimensional array of attributes. The first index holds the attributes. The order is determined by the array "names". The second index holds the values for the instances (ieIndex).

ieIndex - The instances index within the "values" array.

Returns:

true if at least one attribute != null was found

checkElementName

protected void checkElementName()
                         throws InitializationFailedException

Throws:

InitializationFailedException

init

public void init(java.lang.String elementName,
        ODSCache odsCache,
        java.lang.String insertMode,
        boolean rememberInstances,
        boolean logExisting,
        boolean versionIsLong,
        boolean abortOnMissingTargetAttr,
        java.lang.String errorReasonProperty,
        boolean logMissingAttributes)
          throws InitializationFailedException

Throws:

InitializationFailedException

init

public void init(java.lang.String elementName,
        ODSCache odsCache,
        java.lang.String insertMode,
        boolean rememberInstances,
        boolean logExisting,
        boolean versionIsLong,
        boolean abortOnMissingTargetAttr,
        java.lang.String errorReasonProperty)
          throws InitializationFailedException

Throws:

InitializationFailedException

init

public void init(java.lang.String elementName,
        ODSCache odsCache,
        java.lang.String insertMode,
        boolean rememberInstances,
        boolean logExisting,
        boolean versionIsLong,
        boolean abortOnMissingTargetAttr,
        java.lang.String errorReasonProperty,
        java.lang.String attributeBaseName,
        boolean logMissingAttributes)
          throws InitializationFailedException

Throws:

InitializationFailedException

init

public void init()
          throws InitializationFailedException

The initialization of the rule. The element name, the reference of the ODSCache and the insert mode is loaded from the context.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()

execute

public void execute()
             throws ExecutableException

The execute method, nothing to do.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractSequencerRule

Throws:

ExecutableException - if execution fails.

See Also:

AbstractRule.execute()

terminate

public void terminate()
               throws TerminationException

The terminat method, reset the local variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractSequencerRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()

getUsedNMRelationNames

protected java.lang.String[] getUsedNMRelationNames(NameValueUnit[][] nvu)

Look at the values which target N to M relation names are used in the source.

Parameters:

nvu - 2-dimensional Array of Values. First index is the instance element, second index is the attribute.

Returns:

String Array with all used attribute names

prepareQueryStructureByParent

protected QueryStructure prepareQueryStructureByParent(java.lang.String idName,
                                           java.lang.String nameName,
                                           java.lang.String versionName,
                                           ElemId parentId)

Prepare a query structure to select Id, Name and (optionally) version of all instances within a parent.

Parameters:

idName - Name of the id attribute

nameName - Name of the name attribute

versionName - Name of the version attribute

parentId - ElemId of the parent instance

Returns:

The query structure