com.highqsoft.ascoba

Class CopyInstancesAbstractRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.ascoba.AscobaAbstractRule

com.highqsoft.ascoba.CopyInstancesAbstractRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

Direct Known Subclasses:

CopyInstancesChildrenRule, CopyInstancesRule, CopyInstancesWithFatherChildRule, CopyInstancesWithRelatedRule, CopyInstancesWithRelationsRule, LinkInstancesRule

public abstract class CopyInstancesAbstractRule
extends AscobaAbstractRule

This rule is an abstract rule to copy instances from the source to the target. For more detail see \ref rules_com_highqsoft_ascoba_CopyInstancesAbstractRule

Since:

$Date: 2017/10/02 13:45:36 $

Version:

$Revision: 1.6 $

Author:

Karst Schaap

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.Long,java.lang.Long>	aeIdMap The map with the Id's of the application element
protected boolean	checkInstElem Switch which check the instance in the target
protected boolean	copyInstanceAttributes Switch which set to copy the instance attributes
protected boolean	skipId Switch which set to skip the Id attribute
protected boolean	skipValues Switch which set to skip the values and flags attribute
protected AoSession	targetSess The ASAM ODS session of the target.
protected boolean	useGetValueSeq Switch which set to use the getValueSeq method
protected java.util.HashMap<java.lang.Long,InstanceElement>	userGroupMap The map with the Id of the instances of the usergroup.
protected boolean	withSecurity Switch which tells the implementation to copy the security information.

Fields inherited from class com.highqsoft.ascoba.AscobaAbstractRule

elementName, handledMap, messenger, sourceSess, useDestroy

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
CopyInstancesAbstractRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyInitialRights(InstanceElement ie, InstanceElement targetIe) Copy the Rights from the source to the target instance element.
protected void	copyRights(InstanceElement ie, InstanceElement targetIe) Copy the Rights from the source to the target instance element.
protected InstanceElement	createCopiedInstance(InstanceElement ie, ApplicationElement aeTarget, ApplicationElement aeSource) Create at the target application element a copy of the given instance element.
protected DataType	getAttributeDatatype(ApplicationAttribute aa) Get the datatype of an attribute using the cache.
protected java.lang.String	getAttributName(ApplicationAttribute aa) Get the datatype of an attribute using the cache.
protected java.lang.Long	getTargetAID(T_LONGLONG aid) Get the Id of application element in the target of the corresponding application element from the source.
protected InstanceElement	getTargetUserGroup(T_LONGLONG usergroupId) Get the InstanceElement of the AoUserGroup from the target of the corresponding usergroup instance element in the source.
NameValueUnit[][]	getValue() ElementToRule, nothing to do at getValue()
void	init(java.lang.String logger_name) The initialization of the rule.
protected void	linkRelated(InstanceElement ie, InstanceElement ieTarget, ApplicationElement aeSource, ApplicationElement aeTarget, java.lang.String logger_name) Link the related instances from the source, which are already in the target to the target instance element.
protected java.lang.String[]	listAttributes(java.lang.String aeName, ApplicationElement aeTarget, ApplicationElement aeSource, boolean skipId, boolean skipName) List attributes.
protected ApplicationAttribute[]	listElementAttributes(ApplicationElement ae) List the attributes of an element, use the cache of the attributes.
protected InstanceElement	loadFromTarget(ApplicationStructure targetAs, ApplicationElement aeTarget, java.lang.String aeName, InstanceElement ie) Load the corresponding instance from the target application structure of the instance element from the source.
void	terminate(java.lang.String logger_name) The terminate method, reset the local variables.

Methods inherited from class com.highqsoft.ascoba.AscobaAbstractRule

addCopied, addHandledId, checkHandledId, destroy, destroy, execute, getCopiedTarget, getIds, getIds, getIdValue, getTargetApplicationRelation, setValue, setValue, stactTraceToString

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, terminate, 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, init, 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, init, setArguments, setContext, setDescriptor

Field Detail

targetSess

protected AoSession targetSess

The ASAM ODS session of the target.

withSecurity

protected boolean withSecurity

Switch which tells the implementation to copy the security information.

userGroupMap

protected java.util.HashMap<java.lang.Long,InstanceElement> userGroupMap

The map with the Id of the instances of the usergroup.

aeIdMap

protected java.util.HashMap<java.lang.Long,java.lang.Long> aeIdMap

The map with the Id's of the application element

useGetValueSeq

protected boolean useGetValueSeq

Switch which set to use the getValueSeq method

copyInstanceAttributes

protected boolean copyInstanceAttributes

Switch which set to copy the instance attributes

skipId

protected boolean skipId

Switch which set to skip the Id attribute

skipValues

protected boolean skipValues

Switch which set to skip the values and flags attribute

checkInstElem

protected boolean checkInstElem

Switch which check the instance in the target

Constructor Detail

CopyInstancesAbstractRule

public CopyInstancesAbstractRule()

Method Detail

getValue

public NameValueUnit[][] getValue()

ElementToRule, nothing to do at getValue()

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AscobaAbstractRule

Returns:

The name value of the rule.

See Also:

RuleIF.getValue()

init

public void init(java.lang.String logger_name)
          throws InitializationFailedException

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

Overrides:

init in class AscobaAbstractRule

Parameters:

logger_name - the name of the logger.

Throws:

InitializationFailedException - any error which will break the rule

See Also:

AbstractImplementation.init()

terminate

public void terminate(java.lang.String logger_name)
               throws TerminationException

The terminate method, reset the local variables.

Overrides:

terminate in class AscobaAbstractRule

Throws:

TerminationException

See Also:

AbstractRule.terminate()

getTargetAID

protected java.lang.Long getTargetAID(T_LONGLONG aid)
                               throws AoException

Get the Id of application element in the target of the corresponding application element from the source.

Parameters:

aid - The application element Id from the source.

Returns:

the application element Id in the target.

Throws:

AoException - any occurring ASAM ODS exception

loadFromTarget

protected InstanceElement loadFromTarget(ApplicationStructure targetAs,
                             ApplicationElement aeTarget,
                             java.lang.String aeName,
                             InstanceElement ie)
                                  throws AoException

Load the corresponding instance from the target application structure of the instance element from the source. When then Id is skipped, the ASAM Path is used to get the instance. When the Id is not skipped, the Id will be used als key.

Parameters:

targetAs - The target application structure.

aeTarget - the target application element.

aeName - the name of the application element.

ie - the instance of the source.

Returns:

the instances of the target

Throws:

AoException - any occurring ASAM ODS Exception.

getTargetUserGroup

protected InstanceElement getTargetUserGroup(T_LONGLONG usergroupId)
                                      throws AoException

Get the InstanceElement of the AoUserGroup from the target of the corresponding usergroup instance element in the source.

Parameters:

usergroupId - the Id of the usergroup instance in the source.

Returns:

the instance element in the target.

Throws:

AoException - any occurring ASAM ODS exception

copyRights

protected void copyRights(InstanceElement ie,
              InstanceElement targetIe)
                   throws AoException

Copy the Rights from the source to the target instance element.

Parameters:

ie - the source instance element

targetIe - the target instance element.

Throws:

AoException - any occurring ASAM ODS exception

copyInitialRights

protected void copyInitialRights(InstanceElement ie,
                     InstanceElement targetIe)
                          throws AoException

Copy the Rights from the source to the target instance element.

Parameters:

ie - the source instance element

targetIe - the target instance element.

Throws:

AoException - any occurring ASAM ODS exception

listAttributes

protected java.lang.String[] listAttributes(java.lang.String aeName,
                                ApplicationElement aeTarget,
                                ApplicationElement aeSource,
                                boolean skipId,
                                boolean skipName)
                                     throws AoException

List attributes. List the attributes of the application element which are available in both the source and target application element.

Parameters:

aeName - name of the element

aeTarget - the target application element

aeSource - the source application element

skipId - skip the based attribute Id

skipName - skip the based attribute name

Returns:

the list with attributes

Throws:

AoException - any occurring ASAM ODS exception.

listElementAttributes

protected ApplicationAttribute[] listElementAttributes(ApplicationElement ae)
                                                throws AoException

List the attributes of an element, use the cache of the attributes.

Parameters:

ae - the element

Returns:

the list of attributes

Throws:

AoException - any occurred ASAM ODS exception

getAttributeDatatype

protected DataType getAttributeDatatype(ApplicationAttribute aa)
                                 throws AoException

Get the datatype of an attribute using the cache.

Parameters:

aa - the attribute

Returns:

the datatype

Throws:

AoException - any occurring ASAM ODS exception.

getAttributName

protected java.lang.String getAttributName(ApplicationAttribute aa)
                                    throws AoException

Get the datatype of an attribute using the cache.

Parameters:

aa - the attribute

Returns:

the datatype

Throws:

AoException - any occurring ASAM ODS exception.

createCopiedInstance

protected InstanceElement createCopiedInstance(InstanceElement ie,
                                   ApplicationElement aeTarget,
                                   ApplicationElement aeSource)
                                        throws AoException

Create at the target application element a copy of the given instance element.

Parameters:

ie - the instance element to copy

aeTarget - the target application element.

aeSource - the source application element.

Returns:

the new created instance element

Throws:

AoException - any occurring ASAM ODS Exception.

linkRelated

protected void linkRelated(InstanceElement ie,
               InstanceElement ieTarget,
               ApplicationElement aeSource,
               ApplicationElement aeTarget,
               java.lang.String logger_name)
                    throws AoException

Link the related instances from the source, which are already in the target to the target instance element.

Parameters:

ie - the source instances element.

ieTarget - then target instances element.

aeSource - the source application element.

aeTarget - the target application element.

logger_name - the name of the Logger.

Throws:

AoException - any occurring ASAM ODS exception.