psdi.mbo.iterator

Class MboRelationPath

java.lang.Object

psdi.mbo.iterator.MboRelationPath

public class MboRelationPath
extends java.lang.Object

Stores the relationship name and any attached conditions. This class is used to setup MboSetIterators that visit every Mbo in the set

Author:

John Neville

See Also:

MboSetIterator, RelatedMboFetcher

Constructor Summary

Constructors

Constructor and Description
MboRelationPath(java.lang.String relationship) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getDiscardable()
MaxCondition	getMaxCondition() Return the condition.
MboSetRemote	getOnTheFlySet(MboRemote mbo) Get the on-the-fly set.
java.lang.String	getRelationship() Return the base relationship name.
java.lang.Integer	getSpecificMbo() Get the specific Mbo position to return.
boolean	isOnTheFly() Setting the whereFilter will mean an on-the-fly relationship will be created.
static java.util.List<MboRelationPath>	parseRelationshipPath(java.lang.String relationshipChain) Convert a String chain of relationships into a list of MRP's
void	setCondition(java.lang.String condition) Set the condition id.
void	setSpecificMbo(java.lang.Integer specificMbo) Give a value for the specific Mbo.
void	setWhereFilter(java.lang.String whereFilter) Set the addition where filter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MboRelationPath

public MboRelationPath(java.lang.String relationship)

Constructor

Method Detail

getRelationship

public java.lang.String getRelationship()

Return the base relationship name.

getSpecificMbo

public java.lang.Integer getSpecificMbo()

Get the specific Mbo position to return.

setSpecificMbo

public void setSpecificMbo(java.lang.Integer specificMbo)

Give a value for the specific Mbo.

setCondition

public void setCondition(java.lang.String condition)

Set the condition id.

setWhereFilter

public void setWhereFilter(java.lang.String whereFilter)

Set the addition where filter. Ignored if empty.

getMaxCondition

public MaxCondition getMaxCondition()
                             throws java.rmi.RemoteException,
                                    MXApplicationException

Return the condition. Looks up the MaxCondition based on the condition id given earlier.

Returns:

The MaxCondition object.

Throws:

MXException - Thrown with "system","conditionMissing" with the Condition name, if the condition is not found in the cache.

java.rmi.RemoteException

MXApplicationException

See Also:

This method does a similar job.

isOnTheFly

public boolean isOnTheFly()

Setting the whereFilter will mean an on-the-fly relationship will be created. One that is based on the relationship given, combine with the whereFilter.

Returns:

true, if whereFilter was given.

getOnTheFlySet

public MboSetRemote getOnTheFlySet(MboRemote mbo)
                            throws java.rmi.RemoteException,
                                   MXException

Get the on-the-fly set. Used when the whereFilter is set.

Throws:

java.rmi.RemoteException

MXException

parseRelationshipPath

public static java.util.List<MboRelationPath> parseRelationshipPath(java.lang.String relationshipChain)

Convert a String chain of relationships into a list of MRP's

Parameters:

relationshipChain - I.e. 'poline[cond:cond1].pocost[3]'

Returns:

The list of MRP's, the first MRP is the leftmost segment in the string.

getDiscardable

public java.lang.Boolean getDiscardable()