com.highqsoft.moma.rules.ods

Class GetDocuments

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.ods.GetDocuments

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class GetDocuments
extends AbstractSequencerRule

This rule get the Id's of the Document instances.

Since:

$Date: 2017/04/06 13:30:20 $

Version:

$Revision: 1.17 $

Author:

Karst Schaap

Field Summary

Fields

Modifier and Type	Field and Description
protected QueryStructureExt	checkElement
protected java.lang.String	documentElement
protected SelValueExt	elementCondition
protected java.lang.String	elementName
protected QueryStructureExt	getDocuments
protected SelValueExt	instanceCondition
protected ODSCache	odsCache
protected java.lang.String	refAeAttr
protected java.lang.String	refIeAttr
protected java.lang.String[]	stopAtElementList
protected java.lang.String	stopAtElements

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addChildrenReferences(ODSCache odsCache, T_LONGLONG aidDoc, java.lang.String elementName, T_LONGLONG[] ids, ApplRel childRel, java.util.Vector<NameValueUnit[]> foundDocuments) Add the referenced documents of the children.
void	execute() The execute method, nothing to do.
protected NameValueUnit[][]	getResult(ResultSetExt[] resultSet) Convert the result set in a NameValueUnit package.
protected boolean	haveReferenceDocuments(ODSCache odsCache, T_LONGLONG aidDoc, java.lang.String elementName) Determine whether there are any documents referencing the given element.
void	init() The init method.
protected T_LONGLONG[]	loadChildrenIds(ODSCache odsCache, java.lang.String elementName, T_LONGLONG[] ids, ApplRel childRel) Load the Ids of the children instances.
protected void	loadReferenceDocuments(ODSCache odsCache, T_LONGLONG aidDoc, java.lang.String elementName, T_LONGLONG[] ids, java.util.Vector<NameValueUnit[]> foundDocuments) Load the Id, the parentAeName and parentIeName from the Document element.
void	setValue(NameValueUnit[][] nvu) Set the data set in the rule, the rule will load the Id's of the Document.
void	terminate() The terminate method reset the class 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

documentElement

protected java.lang.String documentElement

refAeAttr

protected java.lang.String refAeAttr

refIeAttr

protected java.lang.String refIeAttr

stopAtElements

protected java.lang.String stopAtElements

stopAtElementList

protected java.lang.String[] stopAtElementList

odsCache

protected ODSCache odsCache

checkElement

protected QueryStructureExt checkElement

getDocuments

protected QueryStructureExt getDocuments

elementCondition

protected SelValueExt elementCondition

instanceCondition

protected SelValueExt instanceCondition

Constructor Detail

GetDocuments

public GetDocuments()

Method Detail

init

public void init()
          throws InitializationFailedException

The init method.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()

haveReferenceDocuments

protected boolean haveReferenceDocuments(ODSCache odsCache,
                             T_LONGLONG aidDoc,
                             java.lang.String elementName)
                                  throws AoException

Determine whether there are any documents referencing the given element.

Parameters:

odsCache - the ODS application model cache.

aidDoc - the Id of the document element.

elementName - the name of the reference element.

Returns:

true when at least one of the instances of the element have a entry in the documents

Throws:

AoException - any occurring ASAM ODS exception.

getResult

protected NameValueUnit[][] getResult(ResultSetExt[] resultSet)
                               throws AoException

Convert the result set in a NameValueUnit package.

Parameters:

alias - the alias names

resultSet - the result set

Returns:

the NameValueUnit package.

Throws:

AoException - Ao_NOT_IMPLEMENTED for the not implemented datatypes.

loadReferenceDocuments

protected void loadReferenceDocuments(ODSCache odsCache,
                          T_LONGLONG aidDoc,
                          java.lang.String elementName,
                          T_LONGLONG[] ids,
                          java.util.Vector<NameValueUnit[]> foundDocuments)
                               throws AoException

Load the Id, the parentAeName and parentIeName from the Document element.

Parameters:

odsCache - the ODS application model cache.

aidDoc - the Id of the Document element.

elementName - the name of the reference elemenet (content of parentAeName)

ids - list with Ids of the reference instances.

foundDocuments - the list with the found element where the new found element must be added.

Throws:

AoException - any occurring ASAM ODS exception.

loadChildrenIds

protected T_LONGLONG[] loadChildrenIds(ODSCache odsCache,
                           java.lang.String elementName,
                           T_LONGLONG[] ids,
                           ApplRel childRel)
                                throws AoException

Load the Ids of the children instances.

Parameters:

odsCache - the ODS application model cache.

elementName - the parent element

ids - the list with parent instance Ids.

childRel - the child relation.

Returns:

the list with child Instance Ids.

Throws:

AoException - any occurring ASAM ODS exception.

addChildrenReferences

protected void addChildrenReferences(ODSCache odsCache,
                         T_LONGLONG aidDoc,
                         java.lang.String elementName,
                         T_LONGLONG[] ids,
                         ApplRel childRel,
                         java.util.Vector<NameValueUnit[]> foundDocuments)
                              throws AoException

Add the referenced documents of the children.

Parameters:

odsCache - the ODS cache.

aidDoc - the Id of the document element.

elementName - the element name of the parent element.

ids - the Ids of the parent instances.

childRel - the relation to the child element.

foundDocuments - the found documents

Throws:

AoException - any occurring ASAM ODS exception.

setValue

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

Set the data set in the rule, the rule will load the Id's of the Document.

Parameters:

nvu - the dataset with the Id of the referencing element.

Throws:

RuleException

See Also:

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

execute

public void execute()
             throws ExecutableException

Description copied from class: AbstractSequencerRule

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

Description copied from class: AbstractSequencerRule

The terminate method reset the class variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractSequencerRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()