|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Field Summary | |
static java.lang.String |
TYPE_BASE
Concepts of type BASE can be used to define a Conceptual Model. |
static java.lang.String |
TYPE_DB
Concepts of type DB are based directly on a table. |
static java.lang.String |
TYPE_MINING
Concepts that are the result of an operator are of type MINING. |
Method Summary | |
void |
addColumnSet(Columnset cs)
Add a columnset to this concept's columnsets. |
void |
addFeature(Feature f)
Add a Feature (a BaseAttribute or a MultiColumnFeature) to this concept. |
void |
addFromProjection(Projection projection)
Adds a From-Projection. |
void |
addSubConcept(Concept newSubConcept)
Adds a Sub Concept. |
void |
addSuperConcept(Concept newSuperConcept)
Adds a Super Concept and check for cycles in the inheritance graph. |
void |
addToProjection(Projection projection)
Adds a To-Projection. |
void |
connect(java.lang.String nameOfDbObject,
boolean isTable,
java.util.Map columnNamesForAttribs)
This method connects this Concept to a DB object, either a table or view, by creating a Columnset and Columns for the DB object and connecting this Concept's BaseAttributes to the Columns according to the information in the given Map. |
Concept |
copy(Case newCase)
|
BaseAttribute |
createBaseAttribute(java.lang.String name,
java.lang.String datatype,
java.lang.String attributeType)
Creates a BaseAttribute that is connected to this Concept. |
Columnset |
createColumnset(java.lang.String name,
java.lang.String schema,
java.lang.String type)
Creates a new ColumnSet that is connected to this Concept. |
Relation |
createFromConceptRelation(java.lang.String name,
Concept toConcept)
Creates a new Relationship to which this Concept is connected as FromConcept. |
MultiColumnFeature |
createMultiColumnFeature(java.lang.String name)
Creates a new MultiColumnFeature that is connected to this Concept. |
PrimaryKey |
createPrimaryKey(java.util.Collection keyAttribs)
Creates a PrimaryKey for the Columnset of this Concept. |
Projection |
createProjectionToConcept(Concept toConcept,
java.lang.String nameOfProjection)
Create a new Projection from this concept to the given concept. |
java.util.Collection |
getAllBaseAttributes()
Returns ALL BaseAttributes of this Concept, including those that directly belong to a MultiColumnFeature that belongs to this Concept, but do not belong directly to this concept. |
java.util.Collection |
getAllMultiColumnFeatures()
|
java.util.Collection |
getBaseAttribsNotInMcf()
Returns ONLY those BaseAttributes of this Concept that do not belong to a MultiColumnFeature. |
BaseAttribute |
getBaseAttribute(Column column)
Returns the BaseAttribute of this Concept that is connected to the given Column, if it exists. |
BaseAttribute |
getBaseAttribute(java.lang.String name)
|
Columnset |
getColumnset(java.lang.String colunsetname)
|
java.util.Collection |
getColumnSets()
|
java.util.Collection |
getConceptInheritanceAsSubConcept()
Returns the Collection of ConceptInheritance objects with this Concept as a Sub-Concept |
java.util.Collection |
getConceptInheritanceAsSuperConcept()
Returns the Collection of ConceptInheritance objects with this Concept as a Super-Concept |
Columnset |
getCurrentColumnSet()
This method returns a specific columnset: in a compilation where multistep operators have occured, there can be more than one columnset for an input concept. |
java.lang.String |
getCurrentSuffix()
This method returns a suffix for the current Columnset. |
EstimatedStatistics |
getEstimatedStatistics()
|
Feature |
getFeature(int index)
Get a specific Feature by index. |
Feature |
getFeature(java.lang.String name)
Get a specific Feature by name. |
java.lang.String |
getFeatureNames()
Returns a String with comma-separated names of the Features of this Concept. |
java.util.Collection |
getFeatures()
|
Columnset |
getNextColumnSet()
In case of multi step support this method returns the next column set after the current one and increases the internal pointer accordingly. |
int |
getNumberOfFeatures()
Returns the number of features that this Concept has. |
Parameter |
getParameterWhereThisIsOutputConcept()
Return the Parameter object that represents this concept as an output concept parameter (of a certain step). |
PrimaryKey |
getPrimaryKey()
Returns the PrimaryKey of the Columnset of this Concept. |
java.util.Collection |
getProjectionsAsFromConcept()
Returns the From-Projections. |
java.util.Collection |
getProjectionsAsToConcept()
Returns the To-Projections. |
Relation |
getRelationshipFromConcept(Concept fromConcept)
Returns a Relation with this concept as the ToConcept and the given concept as the FromConcept, if such a Relation exists, and NULL otherwise. |
Relation |
getRelationshipToConcept(Concept toConcept)
Returns a Relation with this concept as the FromConcept and the given concept as the ToConcept, if such a Relation exists, and NULL otherwise. |
java.util.Collection |
getStepsWhereThisIsInputConcept()
Returns all Steps in the Case that use this Concept as an input concept. |
Step |
getStepWhereThisIsOutputConcept()
Returns the Step in the Case where this Concept is created as the output concept. |
java.util.Collection |
getSubConcepts()
This method gets the set of all sub concepts |
java.util.Collection |
getSuperConcepts()
This method gets the set of all super concepts |
Case |
getTheCase()
Getter method. |
Concept |
getTheFromProjection()
|
java.util.Collection |
getTheFromRelationships()
Returns a Collection of Relations in which this concept is the FromConcept. |
Concept |
getTheSuperConcept()
Usually there is only one Super Concept. |
java.util.Collection |
getTheToRelationships()
Returns a Collection of Relations in which this concept is the ToConcept. |
java.lang.String |
getType()
Getter method. |
boolean |
hasColumnset(Columnset cs)
|
boolean |
hasFeature(Feature f)
|
boolean |
hasNextColumnSet()
In case of multi step support this method answers the question if getNextColumnSet() will succeed. |
void |
initMultiStepSupport(java.util.Collection columnsets)
This method is invoked to initialize the support for concepts referring to multiple column sets (multi steps). |
boolean |
isRelationallyValid()
This method returns information about the relational validity of the object. |
boolean |
isValidSubconcept(Concept potentialSubConcept)
Checks wether the given concept has the same features as this one (correspondence of features is by name). |
void |
propagateChangesToDependingConcepts()
When this Concept has changed its Features, depending concepts of later steps can be adapted with this method. |
void |
removeAllColumnsets()
|
void |
removeAllFeatures()
Remove all features from this concept. |
boolean |
removeColumnset(Columnset cs)
Remove a Columnset from this concept. |
void |
removeConnection()
Removes the connection of this Concept to its current Columnset, but ONLY if this Concept is of type 'DB'. |
boolean |
removeFeature(Feature feature)
Remove a Feature (a BaseAttribute or a MultiColumnFeature) from this concept. |
boolean |
removeFeatureByName(java.lang.String name)
Remove a Feature (a BaseAttribute or a MultiColumnFeature) with the given name from this concept. |
boolean |
removeFromProjection(Projection projection)
Removes a From-Projection. |
void |
removeSubConcept(Concept subCon)
Removes a Sub Concept. |
void |
removeSuperConcept(Concept superCon)
Removes a Super Concept. |
boolean |
removeToProjection(Projection projection)
Removes a To-Projection. |
void |
resetColumnSets()
In case of multi step support this method resets the internal pointer to the current column set to the first one. |
void |
setColumnSets(java.util.Collection theColumnsets)
Set the columnsets of this concept. |
void |
setFeatures(java.util.Collection theFeatures)
Set all Features into this concept. |
void |
setTheCase(Case ca)
Sets the case for this concept |
void |
setTheFromProjection(Concept newFromProjection)
Sets the From-Projection as the only From-Projection of this Concept |
void |
setTheSuperConcept(Concept newSuperConcept)
Sets the Super Concept to be the only Super Concept of this Concept |
void |
setType(java.lang.String t)
Setter method for the type of this concept. |
Methods inherited from interface edu.udo.cs.miningmart.m4.ParameterObject |
addParameterReference, getParameterReferences, removeParameterReference |
Methods inherited from interface edu.udo.cs.miningmart.m4.GraphicalM4Object |
getPoint, setPoint |
Methods inherited from interface edu.udo.cs.miningmart.m4.M4Data |
deleteSoon, 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, print, putM4ObjectToCache, replaceSpacesInName, setId, setName |
Field Detail |
public static final java.lang.String TYPE_BASE
public static final java.lang.String TYPE_DB
public static final java.lang.String TYPE_MINING
Method Detail |
public void setType(java.lang.String t) throws M4Exception
t
- the new type (one of "DB", "Base", "Mining")
M4Exception
public java.lang.String getType()
public Parameter getParameterWhereThisIsOutputConcept() throws M4Exception
M4Exception
public java.util.Collection getStepsWhereThisIsInputConcept() throws M4Exception
M4Exception
public Step getStepWhereThisIsOutputConcept() throws M4Exception
M4Exception
public EstimatedStatistics getEstimatedStatistics() throws M4Exception
M4Exception
public void addColumnSet(Columnset cs) throws M4Exception
cs
- the additional columnset
M4Exception
public boolean removeColumnset(Columnset cs) throws M4Exception
cs
- the Columnset
M4Exception
public boolean hasColumnset(Columnset cs) throws M4Exception
cs
- a Columnset
true
if a Columnset
with the same ID is already
linked to this Concept
M4Exception
public void setColumnSets(java.util.Collection theColumnsets) throws M4Exception
theColumnsets
- An array with the new columnsets.
M4Exception
public java.util.Collection getColumnSets() throws M4Exception
M4Exception
public java.lang.String getCurrentSuffix()
public void initMultiStepSupport(java.util.Collection columnsets)
columnsets
- An array of column sets this concept refers to.public Columnset getCurrentColumnSet() throws M4Exception
M4Exception
public void resetColumnSets()
public boolean hasNextColumnSet() throws M4Exception
M4Exception
public Columnset getNextColumnSet() throws M4Exception
M4Exception
public Case getTheCase() throws M4Exception
Case
this Concept
belongs to
M4Exception
public void setTheCase(Case ca) throws M4Exception
ca
- the Case
this Concept
belongs to
M4Exception
public void addFeature(Feature f) throws M4Exception
f
- the new Feature
M4Exception
public Feature getFeature(java.lang.String name) throws M4Exception
name
- the name
M4Exception
public Feature getFeature(int index) throws M4Exception
index
- the index
M4Exception
public java.lang.String getFeatureNames() throws M4Exception
M4Exception
public boolean removeFeature(Feature feature) throws M4Exception
M4Exception
public boolean removeFeatureByName(java.lang.String name) throws M4Exception
name
- the Name
M4Exception
public void removeAllFeatures() throws M4Exception
M4Exception
public void setFeatures(java.util.Collection theFeatures) throws M4Exception
M4Exception
public java.util.Collection getFeatures() throws M4Exception
M4Exception
public int getNumberOfFeatures() throws M4Exception
M4Exception
public boolean hasFeature(Feature f) throws M4Exception
f
- a Feature
true
if a Feature
with the same ID is already
linked to this Concept
M4Exception
public void propagateChangesToDependingConcepts() throws M4Exception
M4Exception
public java.util.Collection getTheFromRelationships() throws M4Exception
M4Exception
public java.util.Collection getTheToRelationships() throws M4Exception
M4Exception
public Relation getRelationshipFromConcept(Concept fromConcept) throws M4Exception
fromConcept
- the given FromConcept
M4Exception
public Relation getRelationshipToConcept(Concept toConcept) throws M4Exception
toConcept
- the given toConcept
M4Exception
public java.util.Collection getConceptInheritanceAsSuperConcept() throws M4Exception
Collection
of ConceptInheritance
M4Exception
public java.util.Collection getConceptInheritanceAsSubConcept() throws M4Exception
Collection
of ConceptInheritance
M4Exception
public java.util.Collection getSuperConcepts() throws M4Exception
Collection
of Concept
s
M4Exception
public java.util.Collection getSubConcepts() throws M4Exception
Collection
of Concept
s
M4Exception
public Concept getTheSuperConcept() throws M4Exception
null
M4Exception
public void addSubConcept(Concept newSubConcept) throws M4Exception
newSubConcept
- The Sub Concept to add
M4Exception
public void addSuperConcept(Concept newSuperConcept) throws M4Exception
newSuperConcept
- The Super Concept to add
M4Exception
public void setTheSuperConcept(Concept newSuperConcept) throws M4Exception
newSuperConcept
- The Super Concept to set
M4Exception
public void removeSubConcept(Concept subCon) throws M4Exception
M4Exception
public void removeSuperConcept(Concept superCon) throws M4Exception
M4Exception
public boolean isValidSubconcept(Concept potentialSubConcept) throws M4Exception
M4Exception
public Projection createProjectionToConcept(Concept toConcept, java.lang.String nameOfProjection) throws M4Exception
M4Exception
public void addToProjection(Projection projection) throws M4Exception
projection
- The Projection to add with this Concept as the To-Concept
M4Exception
public boolean removeToProjection(Projection projection) throws M4Exception
projection
- The Projection (with this Concept as the To-Concept) to be removed
true
if the object was found and removed from the
Collection
M4Exception
public void addFromProjection(Projection projection) throws M4Exception
projection
- The Projection to add with this Concept as the From-Concept
true
if the object was found and removed from the
Collection
M4Exception
public boolean removeFromProjection(Projection projection) throws M4Exception
projection
- The Projection (with this Concept as the From-Concept) to be removed
M4Exception
public void setTheFromProjection(Concept newFromProjection) throws M4Exception
Concept
newFromProjection
- The From-Projection to set
M4Exception
public Concept getTheFromProjection() throws M4Exception
Concept
which this Concept
is a Projection
from.
M4Exception
public java.util.Collection getProjectionsAsFromConcept() throws M4Exception
Collection
of Projection
objects
M4Exception
public java.util.Collection getProjectionsAsToConcept() throws M4Exception
Collection
of Projection
objects
M4Exception
public boolean isRelationallyValid() throws M4Exception
M4Exception
public BaseAttribute createBaseAttribute(java.lang.String name, java.lang.String datatype, java.lang.String attributeType) throws M4Exception
M4Exception
- when an error occurs during creation of the object.public Columnset createColumnset(java.lang.String name, java.lang.String schema, java.lang.String type) throws M4Exception
M4Exception
- when an error occurs during creation of the object.public Columnset getColumnset(java.lang.String colunsetname) throws M4Exception
M4Exception
public void removeAllColumnsets() throws M4Exception
M4Exception
public Concept copy(Case newCase) throws M4Exception
M4Exception
public BaseAttribute getBaseAttribute(java.lang.String name) throws M4Exception
M4Exception
public BaseAttribute getBaseAttribute(Column column) throws M4Exception
column
- the Column
M4Exception
public java.util.Collection getAllBaseAttributes() throws M4Exception
M4Exception
public java.util.Collection getBaseAttribsNotInMcf() throws M4Exception
M4Exception
public void connect(java.lang.String nameOfDbObject, boolean isTable, java.util.Map columnNamesForAttribs) throws M4Exception
nameOfDbObject
- name of a table or view in the business data schemaisTable
- TRUE iff 'nameOfDbObject' refers to a table (otherwise a view
is assumed)columnNamesForAttribs
- a Map that maps every BaseAttribute
of this Concept to a String. The String is the name of the Column that this
BaseAttribute will be connected to.
M4Exception
public void removeConnection() throws M4Exception
M4Exception
public PrimaryKey createPrimaryKey(java.util.Collection keyAttribs) throws M4Exception
keyAttribs
- a Collection of BaseAttributes, each of which is part of the PrimaryKey
M4Exception
public PrimaryKey getPrimaryKey() throws M4Exception
M4Exception
public MultiColumnFeature createMultiColumnFeature(java.lang.String name) throws M4Exception
M4Exception
- when an error occurs during creation of the object.public java.util.Collection getAllMultiColumnFeatures() throws M4Exception
M4Exception
public Relation createFromConceptRelation(java.lang.String name, Concept toConcept) throws M4Exception
name
- the name for the relationshiptoConcept
- the Concept the relationship should point to
M4Exception
- when an error occurs during creation of the object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |