com.bea.p13n.rules.model
Class SegmentModel

java.lang.Object
  com.bea.p13n.model.Model
      com.bea.p13n.model.XmlObjectModel
          com.bea.p13n.rules.model.ClauseModel
              com.bea.p13n.rules.model.SegmentModel

All Implemented Interfaces

Serializable, Cloneable

public class SegmentModel
extends ClauseModel

A model representing a rule condition clause which checks for a set of segment names. This model code doesn't check the clauseType since it only supports a single structure.

See Also

Serialized Form

Nested Class Summary

static class

SegmentModel.Recognizer An object which can recognize SegmentModels from xml.

Nested classes/interfaces inherited from class com.bea.p13n.model.Model

Model.ChangeEvent, Model.ChangeListener, Model.ChangeSupport, Model.Debug

Field Summary

static String

CLAUSE_TYPE The standard clauseType for a SegmentModel.

Fields inherited from class com.bea.p13n.rules.model.ClauseModel

clauseType

Fields inherited from class com.bea.p13n.model.XmlObjectModel

copyRootXmlObject, instanceUri, isComplete

Fields inherited from class com.bea.p13n.model.Model

childrenModels, docModel, parentModel, roChildrenModels

Constructor Summary

SegmentModel()

Method Summary

void	clearCachedData() Clear any cached data.
org.apache.xmlbeans.XmlObject	createNewXmlObject(String clauseType) Create a new, empty xml structure of this model.
protected boolean	determineIsComplete() Determine if this model is complete.
com.bea.p13n.expression.schema.MultiConditionalOperator	getMultiConditionalOperator() Get the top-most multi-conditional-operator (should be <multi-and> or <multi-or>).
PropertyContainer.JoinType	getOuterJoin() Get the outer join logic (AND to require matching all segments, OR to require any segment).
String[]	getSegments() Get the segment names this clause checks.
protected String[]	getSegmentsNoCache()
void	setSegments(String... segments) Set the segment names this clause checks.
protected void	setSegments(String[] segments, boolean forceSet) Set the segment names this clause checks.
void	setXmlObject(String clauseType, org.apache.xmlbeans.XmlObject clause) Set the root xml object for this model.

Methods inherited from class com.bea.p13n.rules.model.ClauseModel

addBranch, addLiteral, addMethod, addMethodOrOperator, addOperator, addVariable, addVariableBinding, copy, getClauseType, getContainingRuleModel, getCopyXmlObject, initializeNew, isInActions, isInConditions, isValidTypeAlias, isValidVariableName, makeSafeCopy, toString

Methods inherited from class com.bea.p13n.model.XmlObjectModel

checkElement, childAdded, childRemoved, fixQName, getApplicationInstanceUri, getChild, getDocument, getLocalName, getParent, getQName, getRootXmlObject, isComplete, isNil, preRemove, propertyChanged, removeAllChildren, removeChild, setApplicationInstanceUri, setIsComplete, setIsComplete, setParent, setRootXmlObject

Methods inherited from class com.bea.p13n.model.Model

addChangeListener, addChild, addChild, clone, doubleEquals, equals, getChildren, getDebug, getDebug, getDocument, getParent, longEquals, removeChangeListener, removeChild, removeChild, removeEmpties, setDocument

Methods inherited from class java.lang.Object

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

Field Detail

CLAUSE_TYPE

public static final String CLAUSE_TYPE

The standard clauseType for a SegmentModel.

See Also

Constants Summary

Constructor Detail

SegmentModel

public SegmentModel()

Method Detail

setXmlObject

public void setXmlObject(String clauseType,
                         org.apache.xmlbeans.XmlObject clause)
                  throws IllegalArgumentException

Set the root xml object for this model.

Overrides:

setXmlObject in class ClauseModel

Parameters

clauseType - the clause type of the clause.

clause - the root xml object of the clause.

Throws

IllegalArgumentException - if clause doesn't match our expected structure.

createNewXmlObject

public org.apache.xmlbeans.XmlObject createNewXmlObject(String clauseType)

Create a new, empty xml structure of this model.

Specified by:

createNewXmlObject in class ClauseModel

Parameters

clauseType - the clause type of the clause.

Returns

a new, empty initialize root object.

clearCachedData

public void clearCachedData()

Clear any cached data.

Specified by:

clearCachedData in class XmlObjectModel

getMultiConditionalOperator

public com.bea.p13n.expression.schema.MultiConditionalOperator getMultiConditionalOperator()

Get the top-most multi-conditional-operator (should be <multi-and> or <multi-or>).

getOuterJoin

public PropertyContainer.JoinType getOuterJoin()

Get the outer join logic (AND to require matching all segments, OR to require any segment).

getSegments

public String[] getSegments()

Get the segment names this clause checks.

getSegmentsNoCache

protected String[] getSegmentsNoCache()

setSegments

protected void setSegments(String[] segments,
                           boolean forceSet)

Set the segment names this clause checks.

Parameters

segments - the list of segments.

forceSet - true to force setting the segments in the xml structure (and no property change event will be fired this case), false to not do if new segments same as old (regular behavior).

setSegments

public void setSegments(String... segments)

Set the segment names this clause checks.

determineIsComplete

protected boolean determineIsComplete()

Determine if this model is complete. SegmentModels are complete is they have at least 1 segment name specified.

Overrides:

determineIsComplete in class XmlObjectModel