com.highqsoft.moma.rules.ods

Class GetInstanceChildren

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.moma.rules.ods.GetInstanceChildren

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class GetInstanceChildren
extends AbstractRule

Since:

$Date: 2017/04/06 13:30:20 $ Modification History: $Log: GetInstanceChildren.java,v $ Revision 1.20 2017/04/06 13:30:20 adil update copyright. Revision 1.19 2016/06/08 01:46:21 florian Update Documentation Revision 1.18 2015/05/20 13:06:29 karst Update Copyrights to current. Revision 1.17 2013/01/03 09:51:52 karst Update copyright to 2013. Revision 1.16 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.15 2012/01/04 08:17:07 karst Update copyright to 2012. Revision 1.14 2011/02/22 13:44:37 karst Update header comment for documentation. Revision 1.13 2011/01/05 09:10:35 karst Update copyright header to 2011 Revision 1.12 2010/06/10 16:03:01 markus Bugfix: Fixed a crash when no children were found. Revision 1.11 2010/02/03 09:17:40 markus Removed the SessionRef property from the documentation header Revision 1.10 2010/01/11 07:56:21 karst Update header comment to current Revision 1.9 2009/10/07 18:01:48 charly Bugfix if an instance has no children Revision 1.8 2009/08/31 10:09:05 karst Update header comment. Revision 1.7 2009/07/21 07:05:54 markus List only application attributes, no instance attributes Revision 1.6 2009/06/30 08:44:44 charly Documentation revised. Revision 1.5 2009/06/19 08:37:57 charly Documentation corrected. Revision 1.4 2009/04/06 11:05:36 markus Bugfix if an instance has no children Revision 1.3 2009/01/05 09:38:43 karst Modify copyright to 2009 Revision 1.2 2008/12/09 11:27:27 markus Read the messages from com/highqsoft/moma/rules during init() Made childPattern an optional property Revision 1.1 2008/11/20 10:00:38 markus Initial Release. Not yet documented the correct way! Revision 1.2 2008/10/30 21:40:30 markus Added property ChildApplElem Revision 1.1 2008/07/24 11:02:26 markus Initial CVS Release

Version:

$Revision: 1.20 $

Author:

Markus Schuldlos

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute the program.
NameValueUnit[][]	getValue() Perform a query and return all found instances.
void	init() The init method.
void	setValue(NameValueUnit[][] nvu) Set the named values to rule.
void	terminate() Terminate the execution.

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

Constructor Detail

GetInstanceChildren

public GetInstanceChildren()

Method Detail

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Perform a query and return all found instances.

Returns:

An NVU matrix containing the attributes of all instances found.

Throws:

RuleException

See Also:

RuleIF.getValue()

init

public void init()
          throws InitializationFailedException

The init method.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()

setValue

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

Description copied from interface: RuleIF

Set the named values to rule. The rule decides how to organize the array structur. To have a homogenous environment try to hold in mind that the first index should assign something like instances and the second the attributes belong to the instances.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

execute

public void execute()
             throws ExecutableException

Description copied from class: AbstractRule

Execute the program. This implementation does nothing by default. Can be overridden.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractRule

Throws:

ExecutableException - if execution fails.

terminate

public void terminate()
               throws TerminationException

Description copied from class: AbstractRule

Terminate the execution. This implementation does nothing by default. Can be overridden.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - if termination fails.