com.highqsoft.transformer

Class AbstractRule

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<AbstractRule>

com.highqsoft.transformer.AbstractRule

All Implemented Interfaces:

java.lang.Iterable<AbstractRule>, java.util.Collection<AbstractRule>, java.util.List<AbstractRule>

Direct Known Subclasses:

AttributeRule, LiteralRule, MethodRule

public abstract class AbstractRule
extends java.util.AbstractList<AbstractRule>

This is the abstract rule.

Since:

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

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
protected AoSession	aoSession
protected RuleEngine	engine

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
AbstractRule(RuleEngine ruleEngine, AoSession aoSession) Create an abstract rule.
AbstractRule(RuleEngine engine, AoSession aoSession, java.util.Collection<AbstractRule> collection) Create an abstract rule and initialize the child list with the given collection elements.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, AbstractRule element) Add a child rule.
int	executePostMethods() Execute post methods.
int	executePreMethods() Execute pre methods.
AbstractRule	get(int index) Get a child from specific index position.
RuleEngine	getEngine() Get the engine.
java.lang.String	getId() Get the id of the rule.
java.util.logging.Logger	getMessenger(java.lang.String name) Get the logger of the rule.
java.lang.String	getPointTo() Get the reference string of the rule.
AoSession	getSession() Get the session that belongs to that rule.
Transformer	getTransformer() Get the transformer.
abstract NameValueUnit	getValue() Get the named value from rule.
boolean	isPedantic() Get the gather mode.
AbstractRule	remove(int index) Remove a chid from specifiy index position.
AbstractRule	set(int index, AbstractRule element) Set the child at a specific index position.
void	setId(java.lang.String id) Set the id of the rule.
void	setMethods(RulePostMethod[] arr) Set the rule pre methods.
void	setMethods(RulePreMethod[] arr) Set the rule pre methods.
void	setPedantic(boolean flag) Set the gather mode.
void	setPointTo(java.lang.String pointTo) Set the ref of the rule.
abstract void	setValue(NameValueUnit nvu) Set the named value from rule.
int	size() Get the total number of children.
java.lang.String	toString() Get the strin gpresentation of the rule.

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Field Detail

engine

protected RuleEngine engine

aoSession

protected AoSession aoSession

Constructor Detail

AbstractRule

public AbstractRule(RuleEngine ruleEngine,
            AoSession aoSession)

Create an abstract rule.

Parameters:

engine - the rule engine that handles this rule.

aoSession - the ASAM ODS session.

AbstractRule

public AbstractRule(RuleEngine engine,
            AoSession aoSession,
            java.util.Collection<AbstractRule> collection)

Create an abstract rule and initialize the child list with the given collection elements.

Parameters:

engine - the rule engine that handles this rule.

aoSession - teh ASAM ODS session.

collection - the initial child list.

Method Detail

getSession

public AoSession getSession()

Get the session that belongs to that rule.

Returns:

the session, may be null

getEngine

public RuleEngine getEngine()

Get the engine.

getTransformer

public Transformer getTransformer()

Get the transformer.

add

public void add(int index,
       AbstractRule element)

Add a child rule.

Specified by:

add in interface java.util.List<AbstractRule>

Overrides:

add in class java.util.AbstractList<AbstractRule>

Parameters:

index - The index of the new child.

element - the new child.

get

public AbstractRule get(int index)

Get a child from specific index position.

Specified by:

get in interface java.util.List<AbstractRule>

Specified by:

get in class java.util.AbstractList<AbstractRule>

Parameters:

index - the child index.

remove

public AbstractRule remove(int index)

Remove a chid from specifiy index position.

Specified by:

remove in interface java.util.List<AbstractRule>

Overrides:

remove in class java.util.AbstractList<AbstractRule>

Parameters:

index - the child index.

set

public AbstractRule set(int index,
               AbstractRule element)

Set the child at a specific index position.

Specified by:

set in interface java.util.List<AbstractRule>

Overrides:

set in class java.util.AbstractList<AbstractRule>

Parameters:

index - the position

element - the child

Returns:

the child

setMethods

public void setMethods(RulePreMethod[] arr)

Set the rule pre methods.

setMethods

public void setMethods(RulePostMethod[] arr)

Set the rule pre methods.

size

public int size()

Get the total number of children.

Specified by:

size in interface java.util.Collection<AbstractRule>

Specified by:

size in interface java.util.List<AbstractRule>

Specified by:

size in class java.util.AbstractCollection<AbstractRule>

Returns:

the total number of available children.

getId

public java.lang.String getId()

Get the id of the rule.

setPointTo

public void setPointTo(java.lang.String pointTo)

Set the ref of the rule.

getPointTo

public java.lang.String getPointTo()

Get the reference string of the rule.

setId

public void setId(java.lang.String id)

Set the id of the rule.

setPedantic

public void setPedantic(boolean flag)

Set the gather mode.

isPedantic

public boolean isPedantic()

Get the gather mode.

Returns:

the gather mode string.

executePreMethods

public int executePreMethods()

Execute pre methods. The method stops to loop through method array if one of the both conditions are true. 1.) The rule's gathermode is pedantic. Stop if the returns status of the execute method is not zero or the execute method throws an exception.
2.) The rule's gathermode is not pedantic. Stop if the execute method throws an exception.

Returns:

FAILED if an exception was thrown else the return value of the method.

See Also:

executePostMethods()

executePostMethods

public int executePostMethods()

Execute post methods. The method stops to loop through method array if one of the both conditions are true. 1.) The rule's gathermode is pedantic. Stop if the returns status of the execute method is not zero or the execute method throws an exception.
2.) The rule's gathermode is not pedantic. Stop if the execute method throws an exception.

Returns:

FAILED if an exception was thrown else the return value of the method.

See Also:

executePreMethods()

getMessenger

public java.util.logging.Logger getMessenger(java.lang.String name)

Get the logger of the rule.

Parameters:

name - the name of the logger.

Returns:

the logger

setValue

public abstract void setValue(NameValueUnit nvu)

Set the named value from rule.

Parameters:

nvu - The name value of the rule.

getValue

public abstract NameValueUnit getValue()

Get the named value from rule.

Returns:

The name value of the rule.

toString

public java.lang.String toString()

Get the strin gpresentation of the rule.

Overrides:

toString in class java.util.AbstractCollection<AbstractRule>