|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.udo.cs.miningmart.m4.core.M4Object
edu.udo.cs.miningmart.m4.core.M4Data
edu.udo.cs.miningmart.m4.core.GraphicalM4Object
edu.udo.cs.miningmart.m4.core.Chain
Field Summary | |
static java.lang.String |
ATTRIB_CASE_ID
|
static java.lang.String |
ATTRIB_CHAIN_DESCR
|
static java.lang.String |
ATTRIB_CHAIN_ID
|
static java.lang.String |
ATTRIB_CHAIN_NAME
|
static java.lang.String |
ATTRIB_PARENTCHAIN_ID
|
static java.lang.String |
M4_TABLE
|
static M4Info |
m4Info
Cache for getM4Info() |
Fields inherited from class edu.udo.cs.miningmart.m4.core.GraphicalM4Object |
graph2coord |
Fields inherited from class edu.udo.cs.miningmart.m4.core.M4Data |
myDocumentation |
Fields inherited from class edu.udo.cs.miningmart.m4.core.M4Object |
myId, myName |
Fields inherited from interface edu.udo.cs.miningmart.m4.utils.XmlInfo |
M4_XML_VERSION, TAG_COLLECTION, TAG_DOUBLE, TAG_INTEGER, TAG_LONG, TAG_M4_ID, TAG_SHORT, TAG_STRING, TAG_XML_ID |
Fields inherited from interface edu.udo.cs.miningmart.m4.utils.M4Table |
NOT_NULL |
Constructor Summary | |
Chain(DB db)
|
Method Summary | |
void |
addStep(Step step)
Adds a Step to this Chain and takes
care about back-reference integrity. |
void |
addSubChain(Chain subchain)
Adds a Chain to this Chain and takes
care about back-reference integrity. |
Chain |
copy(Case newCase)
Make a copy of this chain. |
Chain |
createSubChain(java.lang.String name,
java.util.Collection stepsAndChains)
Creates a new Chain whose parent chain is this Chain. |
void |
deleteSoon()
When a chain is deleted, it moves its steps to its parent chain. |
boolean |
dependencyExists(Chain toChain)
This method checks if there is a dependency between any of the steps of this chain (including all steps of all direct or indirect subchains), and any of the steps of the given chain (again including all steps of all direct or indirect subchains). |
boolean |
dependencyExists(Step toStep)
This method checks if there is a dependency between any of the steps of this chain (including all steps of all direct or indirect subchains), and the given step. |
java.util.Collection |
getAllChains()
Return all direct or indirect subchains of this chain. |
java.util.Collection |
getAllSteps()
Return all steps of this chain and all direct or indirect subchains. |
java.util.Collection |
getAllTransitionsToChain(Chain toChain)
This method returns pairs of Steps. |
java.util.Collection |
getCrossReferences()
Implements the interface HasCrossReferences |
java.util.Collection |
getDependentObjects()
This method is part of the XML-serialization and needs to be implemented by all M4Data sub-classes that need to be serialized. |
java.lang.String |
getDescription()
Gets the description. |
java.util.Collection |
getDirectSubChains()
Active getter of the chains embedded in this chain. |
protected java.util.Collection |
getGraphicallyEmbeddedObjects()
|
java.lang.String |
getIdAttributeName()
|
java.util.Collection |
getInvolvedConcepts()
Returns a Collection of the Concepts that are used as input or output in any of the top level steps of this chain. |
M4Info |
getM4Info()
|
java.lang.String |
getM4TableName()
|
protected java.util.Collection |
getObjectsInNamespace(java.lang.Class typeOfObjects)
This method returns the objects of the specified type that form a namespace in the scope of this M4Data object. |
Chain |
getParentChain()
Gets the parent chain. |
java.util.Collection |
getPredecessors(Step toStep)
This method returns all steps in this chain, including steps in subchains etc., that are a direct predecessor of the given Step. |
java.util.Collection |
getSuccessors(Step fromStep)
This method returns all steps in this chain, including steps in subchains etc., that are a direct successor of the given Step. |
Case |
getTheCase()
Gets the Case. |
java.util.Collection |
getTopLevelSteps()
Active getter of the steps embedded in this chain. |
java.util.Iterator |
getTopLevelStepsSequentialised()
Active getter of the steps embedded in this chain. |
M4Info |
getXmlInfo()
|
protected boolean |
hasCoordinates()
Chain s have coordinates. |
boolean |
hasPredecessorOutside()
This method returns TRUE iff a Step exists in this Chain that is a successor of a Step outside this Chain. |
boolean |
hasSuccessorOutside()
This method returns TRUE iff a Step exists in this Chain that is a predecessor of a Step outside this Chain. |
void |
primitiveSetCase(Case m4case)
Primitive setter of the Case field. |
void |
primitiveSetParentChain(Chain theParentChain)
|
void |
print()
Method to print data about this M4Object. |
protected void |
removeAllM4References()
This method needs to be implemented by all M4Data
objects. |
boolean |
removeStep(Step step)
Removes a Step from this Chain and takes
care about back-reference integrity. |
void |
resolveSubChain(Chain chain)
If the given Chain is a direct subchain of this
Chain , it is resolved, ie its Step s
and subchains become steps and direct subchains of this chain. |
void |
setDescription(java.lang.String description)
Sets the description. |
void |
setParentChain(Chain theParentChain)
Sets the parent chain of this chain to the given parentChain. |
void |
setTheCase(Case m4Case)
Sets a new Case object and cares about
back-reference integrity. |
Methods inherited from class edu.udo.cs.miningmart.m4.core.GraphicalM4Object |
deleteLocal, getCoordinates, getPoint, primitiveSetCoordinates, setCoordinatesDirty, setName, setPoint, storeLocal |
Methods inherited from class edu.udo.cs.miningmart.m4.core.M4Data |
exportLocal, genericGetter, genericSetter, getDocumentation, getObjectsReferencingMe, getObjectsReferencingMe, getObjectTag, getValidName, getXmlIdTag, getXmlVersion, hasDeleteStatus, importLocal, isDirty, isWaitingForDelete, primitiveGetDocObject, primitiveSetDocObject, readFromDb, readFromDbLocal, removeDocObject, removeFromDb, removeSetFromDb, setDirty, setDocumentation, setId, updateObjectsFromTable |
Methods inherited from class edu.udo.cs.miningmart.m4.core.M4Object |
compareTo, doPrint, doPrint, equals, executeBusinessSingleValueSqlRead, executeBusinessSingleValueSqlReadL, executeBusinessSqlRead, executeBusinessSqlWrite, executeM4SingleValueSqlRead, executeM4SingleValueSqlReadL, executeM4SqlRead, executeM4SqlWrite, getCasePrintObject, getId, getM4Db, getM4ObjectFromCache, getName, getNextM4SequenceValue, isNew, load, putM4ObjectToCache, replaceSpacesInName |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface edu.udo.cs.miningmart.m4.utils.XmlInfo |
doPrint, doPrint, exportLocal, genericGetter, genericSetter, getObjectTag, getXmlIdTag, getXmlVersion, importLocal |
Methods inherited from interface edu.udo.cs.miningmart.m4.GraphicalM4Object |
getPoint, setPoint |
Methods inherited from interface edu.udo.cs.miningmart.m4.M4Data |
getDocumentation, getValidName, isDirty, isWaitingForDelete, setDocumentation |
Methods inherited from interface edu.udo.cs.miningmart.m4.M4Object |
doPrint, doPrint, equals, executeBusinessSingleValueSqlRead, executeBusinessSingleValueSqlReadL, executeBusinessSqlRead, executeBusinessSqlWrite, executeM4SingleValueSqlRead, executeM4SingleValueSqlReadL, executeM4SqlRead, executeM4SqlWrite, getCasePrintObject, getId, getM4Db, getM4ObjectFromCache, getName, getNextM4SequenceValue, isNew, load, putM4ObjectToCache, replaceSpacesInName, setId, setName |
Field Detail |
public static final java.lang.String M4_TABLE
public static final java.lang.String ATTRIB_CHAIN_ID
public static final java.lang.String ATTRIB_CASE_ID
public static final java.lang.String ATTRIB_PARENTCHAIN_ID
public static final java.lang.String ATTRIB_CHAIN_NAME
public static final java.lang.String ATTRIB_CHAIN_DESCR
public static M4Info m4Info
Constructor Detail |
public Chain(DB db)
db
- the instance of DB
used for the embedding Case
Method Detail |
public java.lang.String getM4TableName()
getM4TableName
in interface M4Table
M4Table.getM4TableName()
public java.lang.String getIdAttributeName()
getIdAttributeName
in interface M4Table
M4Table.getIdAttributeName()
public M4Info getM4Info()
getM4Info
in interface M4Table
M4Table.getM4Info()
public M4Info getXmlInfo()
getXmlInfo
in interface XmlInfo
M4Info
object with the information
of all XML fields of this
object.XmlInfo.getXmlInfo()
public void print()
M4Object
print
in interface M4Object
print
in class GraphicalM4Object
M4Object.print()
public java.util.Collection getCrossReferences()
getCrossReferences
in interface HasCrossReferences
protected java.util.Collection getObjectsInNamespace(java.lang.Class typeOfObjects) throws M4Exception
M4Data
null
. If a namespace could
exist but doesn't, an empty Collection is returned.
getObjectsInNamespace
in class M4Data
typeOfObjects
- the type of objects that form the namespace
typeOfObjects
,
or null
.
M4Exception
M4Data.getObjectsInNamespace(Class)
public java.util.Collection getTopLevelSteps() throws M4Exception
getTopLevelSteps
in interface Chain
Collection
of Step
s
M4Exception
public java.util.Iterator getTopLevelStepsSequentialised() throws M4Exception
getTopLevelStepsSequentialised
in interface Chain
Iterator
through Step
s, or NULL.
M4Exception
public Chain createSubChain(java.lang.String name, java.util.Collection stepsAndChains) throws M4Exception
createSubChain
in interface Chain
name
- the name to be given to the new chainstepsAndChains
- a Collection
of Step
s
and/or Chain
s.
M4Exception
Case.createChain(String, Collection)
public Case getTheCase()
getTheCase
in interface Chain
public void deleteSoon() throws M4Exception
deleteSoon
in interface M4Data
deleteSoon
in class GraphicalM4Object
M4Exception
public java.util.Collection getAllSteps() throws M4Exception
getAllSteps
in interface Chain
Collection
of Step
s
M4Exception
public java.util.Collection getAllChains() throws M4Exception
getAllChains
in interface Chain
Collection
of Chain
s
M4Exception
public boolean dependencyExists(Step toStep) throws M4Exception
Chain
dependencyExists
in interface Chain
toStep
- the destination step
M4Exception
Chain.dependencyExists(Step)
public boolean dependencyExists(Chain toChain) throws M4Exception
Chain
dependencyExists
in interface Chain
toChain
- the destination chain
M4Exception
Chain.dependencyExists(Chain)
public java.util.Collection getPredecessors(Step toStep) throws M4Exception
getPredecessors
in interface Chain
toStep
- the Step whose predecessors are returned
M4Exception
public java.util.Collection getSuccessors(Step fromStep) throws M4Exception
Chain
getSuccessors
in interface Chain
fromStep
- the Step whose successors are returned
M4Exception
Chain.getSuccessors(Step)
public boolean hasPredecessorOutside() throws M4Exception
Chain
hasPredecessorOutside
in interface Chain
M4Exception
Chain.hasPredecessorOutside()
public boolean hasSuccessorOutside() throws M4Exception
Chain
hasSuccessorOutside
in interface Chain
M4Exception
Chain.hasSuccessorOutside()
public java.util.Collection getAllTransitionsToChain(Chain toChain) throws M4Exception
getAllTransitionsToChain
in interface Chain
toChain
- the given Chain
M4Exception
public java.util.Collection getInvolvedConcepts() throws M4Exception
getInvolvedConcepts
in interface Chain
M4Exception
public Chain getParentChain()
getParentChain
in interface Chain
public java.lang.String getDescription()
getDescription
in interface Chain
public void setTheCase(Case m4Case) throws M4Exception
Case
object and cares about
back-reference integrity.
setTheCase
in interface Chain
m4Case
- the Case
to be set
M4Exception
public void primitiveSetCase(Case m4case)
m4case
- The Case to setpublic void setParentChain(Chain theParentChain) throws M4Exception
Chain
setParentChain
in interface Chain
theParentChain
- the new parent chain of this chain.
M4Exception
public void primitiveSetParentChain(Chain theParentChain)
public void setDescription(java.lang.String description)
setDescription
in interface Chain
description
- The description to setpublic void addStep(Step step) throws M4Exception
Step
to this Chain
and takes
care about back-reference integrity.
addStep
in interface Chain
step
- the Step
to be added
M4Exception
public boolean removeStep(Step step) throws M4Exception
Step
from this Chain
and takes
care about back-reference integrity.
removeStep
in interface Chain
step
- the Step
to be removed
M4Exception
protected void removeAllM4References() throws M4Exception
M4Data
M4Data
objects. It has to remove all references to other
M4Object
s.
removeAllM4References
in class M4Data
M4Exception
M4Data.removeAllM4References()
protected boolean hasCoordinates()
Chain
s have coordinates.
hasCoordinates
in class GraphicalM4Object
protected java.util.Collection getGraphicallyEmbeddedObjects() throws M4Exception
M4Exception
GraphicalM4Object#getGraphicallyEbeddedObjects()
public java.util.Collection getDependentObjects() throws M4Exception
M4Data
M4Data
sub-classes that need to be serialized.
getDependentObjects
in interface XmlInfo
getDependentObjects
in class GraphicalM4Object
M4Exception
M4Data.getDependentObjects()
public Chain copy(Case newCase) throws M4Exception
copy
in interface Chain
M4Exception
copy(Case)
public void addSubChain(Chain subchain) throws M4Exception
Chain
Chain
to this Chain
and takes
care about back-reference integrity. The given Chain will
be a direct subchain of this chain.
addSubChain
in interface Chain
M4Exception
edu.udo.cs.miningmart.m4.Chain#addChain(Chain)
public void resolveSubChain(Chain chain) throws M4Exception
Chain
Chain
is a direct subchain of this
Chain
, it is resolved, ie its Step
s
and subchains become steps and direct subchains of this chain.
resolveSubChain
in interface Chain
chain
- the Chain
to be resolved
M4Exception
Chain.resolveSubChain(Chain)
public java.util.Collection getDirectSubChains() throws M4Exception
Chain
getAllChains()
.
getDirectSubChains
in interface Chain
Collection
of Chain
s
M4Exception
edu.udo.cs.miningmart.m4.Chain#getTopChains()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |