|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Field Summary | |
static java.lang.String |
CS_TYPE_TABLE
DB level: String constant used in the DB to indicate that this columnset is a table |
static java.lang.String |
CS_TYPE_VIEW
DB level: String constant used in the DB to indicate that this columnset is a view |
static java.lang.String |
TYPE_MATERIALIZED_VIEW
|
static java.lang.String |
TYPE_SNAPSHOT
|
static java.lang.String |
TYPE_TABLE
|
static java.lang.String |
TYPE_VIEW
|
Method Summary | |
void |
addColumn(Column c)
Add a column to this columnset's columns. |
void |
addMultiStepBranch(java.lang.String branch)
|
void |
addMultiStepBranchInfo(java.lang.String oldDef,
java.lang.String attribute,
java.lang.String value)
Adds an attribute-value pair to the MultiStepBranch field if the attribute isn't already present there. |
void |
clearStatistics()
If data changes in the database, e.g. a DB Concept is edited, then this method allows to delete the deprecated statistics objects without running a garbage collection. |
Columnset |
copy(Concept newConcept)
|
Column |
createColumn(java.lang.String name,
java.lang.String datatype)
Creates a Column that will be connected to this ColumnSet. |
void |
createColumnsFromDbObject(java.lang.String nameOfTableOrView)
Creates an M4 Column for every column of the table or view with the given name, and connects it to this Columnset. |
ForeignKey |
createForeignKeyWhereThisIsFkCs(java.lang.String name)
Creates a ForeignKey. |
PrimaryKey |
createPrimaryKey(java.lang.String name)
Creates a PrimaryKey. |
Column |
getColumn(int index)
Get a specific column. |
Column |
getColumn(java.lang.String columnName)
|
java.util.Collection |
getColumns()
|
java.lang.String |
getCompleteSQLQuery()
This method returns a complete SQL query, which can be used to get the data as represented by this Columnset .
|
java.lang.String |
getCompleteSQLQuery(java.lang.String rowNumName)
This method returns a complete SQL query, which can be used to get the data as represented by this Columnset .
|
java.util.Collection |
getForeignKeysWhereThisIsFkCs()
Active getter for the Key objects referencing to this
Columnset as their forein key. |
ForeignKey |
getForeignKeyWhereThisIsFkCs(java.lang.String keyName)
|
java.lang.String |
getMsbInfoWithoutAttrib(java.lang.String attributeName)
|
java.lang.String |
getMSBranchSelectionValue(java.lang.String attributeName)
Scans the MultiStepBranch information of the Columnset
for attributeName=Value; and returns the corresponding value,
null otherwise. |
java.lang.String |
getMultiStepBranch()
|
PrimaryKey |
getPrimaryKey()
|
Relation |
getRelation()
Returns the Relation in which this Columnset realizes the cross table, if there is such a Relation. |
java.lang.String |
getSchema()
|
java.lang.String |
getSchemaPlusName()
|
java.lang.String |
getSQLDefinition()
|
java.util.Collection |
getStatistics()
Active getter for the ColumnsetStatistics of this Columnset . |
int |
getStatisticsAll()
Getter method. |
int |
getStatisticsNominal()
Getter method. |
int |
getStatisticsOrdinal()
Getter method. |
int |
getStatisticsTime()
Getter method. |
Concept |
getTheConcept()
|
java.lang.String |
getType()
|
boolean |
hasColumn(Column col)
|
java.lang.String |
readOrComputeCount()
Reads, or computes and inserts into the statistics table, the number of rows of this ColumnSet and returns it as a string. |
void |
removeAllColumns()
|
void |
removeAllForeignKeys()
Removes all ForeignKeys from this ColumnSet. |
boolean |
removeColumn(Column column)
Remove a column from this Columnsets's columns. |
void |
removeForeignKeyWhereThisIsFkCs(java.lang.String name)
Removes the specified ForeignKey for this ColumnSet. |
void |
removePrimaryKey()
Removes the specified PrimaryKey for this ColumnSet. |
void |
setColumn(int index,
Column c)
Set a specific column. |
void |
setColumns(java.util.Collection theColumns)
Set all columns of this columnset. |
void |
setMultiStepBranch(java.lang.String branchDefinition)
Set the information about the multistep branch. |
void |
setPrimaryKey(PrimaryKey primaryKey)
|
void |
setRelation(Relation newRelation)
Sets the connection to a Relation. |
void |
setSchema(java.lang.String s)
Set the database schema where the table or view that this columnset refers to lives. |
void |
setSQLDefinition(java.lang.String sqlDefinition)
Set the sql definition. |
void |
setStatistics(java.util.Collection theStats)
Setter method. |
void |
setStatisticsAll(int sa)
Setter method. |
void |
setStatisticsNominal(int sn)
Setter method. |
void |
setStatisticsOrdinal(int so)
Setter method. |
void |
setStatisticsTime(int st)
Setter method. |
void |
setTheConcept(Concept c)
Set this columnset's concept. |
void |
setType(java.lang.String t)
Set the type of this columnset (table or view). |
void |
updateStatistics()
Executes several SQL procedure queries to calculate statistical information for the given columnset on demand. |
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 CS_TYPE_TABLE
public static final java.lang.String CS_TYPE_VIEW
public static final java.lang.String TYPE_TABLE
public static final java.lang.String TYPE_VIEW
public static final java.lang.String TYPE_SNAPSHOT
public static final java.lang.String TYPE_MATERIALIZED_VIEW
Method Detail |
public void setTheConcept(Concept c) throws M4Exception
c
- the Concept this ColumnSet belongs to
M4Exception
public Concept getTheConcept()
public void setSchema(java.lang.String s)
s
- the schema namepublic java.lang.String getSchema()
public java.lang.String getSchemaPlusName()
public void setType(java.lang.String t) throws M4Exception
t
- A String constant, either Columnset.CS_TYPE_TABLE or Columnset.CS_TYPE_VIEW
M4Exception
public java.lang.String getType()
public void setSQLDefinition(java.lang.String sqlDefinition)
sqlDefinition
- the new definition
A value of null
indicates that there is no explicit
SQL definition, but that the name of the table or view is its defintion
at the same time. If the sqlDefinition is null
then the
method getSQLDefinition()
will return
getSchemaPlusName()
.public java.lang.String getSQLDefinition()
getSchemaPlusName()
. Never returns null
.public java.lang.String getCompleteSQLQuery() throws M4Exception
Columnset
.
In contrast to the method getSQLDefinition()
this
method does also include virtual columns, which are sometimes
not visible at the level of the Columnset's SQL definition.
M4Exception
public java.lang.String getCompleteSQLQuery(java.lang.String rowNumName) throws M4Exception
Columnset
.
The difference to the same method without the additional parameter
is, that this method allows to specify a target attribute name
for the internal Oracle attribute ROWNUM
rowNumName
- the target attribute name of the ROWNUM attribute
M4Exception
Columnset.getCompleteSQLQuery
public void setMultiStepBranch(java.lang.String branchDefinition)
branchDefinition
- The new branch informationpublic java.lang.String getMultiStepBranch()
public void addMultiStepBranchInfo(java.lang.String oldDef, java.lang.String attribute, java.lang.String value) throws M4Exception
oldDef
- The multistep branch information so farattribute
- The attribute
M4Exception
public void addMultiStepBranch(java.lang.String branch) throws M4Exception
branch
- A complete field CS_MSBRANCH
as found in table
COLUMNSET_T. It is added to the CS_MSBRANCH
of this
object via addMultiStepBranchInfo
.
M4Exception
public void setColumns(java.util.Collection theColumns) throws M4Exception
theColumns
- Collection of the new set of column objects
M4Exception
public boolean hasColumn(Column col) throws M4Exception
col
- a Column
true
if a column with the same ID is already linked to this
Columnset
M4Exception
public java.util.Collection getColumns() throws M4Exception
M4Exception
public void setColumn(int index, Column c) throws M4Exception
null
values might also be
problematic!
index
- number of the Columnc
- Column to be set
M4Exception
public Column getColumn(int index) throws M4Exception
index
- number of the Column
M4Exception
public java.util.Collection getForeignKeysWhereThisIsFkCs() throws M4Exception
Key
objects referencing to this
Columnset
as their forein key.
Collection
of Key
objects
M4Exception
public java.util.Collection getStatistics() throws M4Exception
ColumnsetStatistics
of this Columnset
.
Collection
of ColumnsetStatistics
objects, never
null
.
M4Exception
public void setStatistics(java.util.Collection theStats) throws M4Exception
M4Exception
public void setStatisticsAll(int sa) throws M4Exception
sa
- the new value
M4Exception
public int getStatisticsAll() throws M4Exception
M4Exception
public void setStatisticsNominal(int sn) throws M4Exception
sn
- the new value
M4Exception
public int getStatisticsNominal() throws M4Exception
M4Exception
public void setStatisticsOrdinal(int so) throws M4Exception
so
- the new value
M4Exception
public int getStatisticsOrdinal() throws M4Exception
M4Exception
public void setStatisticsTime(int st) throws M4Exception
st
- the new value
M4Exception
public int getStatisticsTime() throws M4Exception
M4Exception
public void addColumn(Column c) throws M4Exception
c
- the additional column
M4Exception
public boolean removeColumn(Column column) throws M4Exception
true
if removing succeeded
M4Exception
public void removeAllColumns() throws M4Exception
M4Exception
public java.lang.String getMSBranchSelectionValue(java.lang.String attributeName) throws M4Exception
Columnset
for attributeName=Value; and returns the corresponding value,
null
otherwise. The attribute name is compared in a case
insensitive way and it is assumed that exactly the format above is
used. Each attribute value pair needs to be terminated by a ';',
no whitespaces in between! If this assumption does not hold parsing
might throw an exception.
attributeName
- The name of the BaseAttribute
or
pseudo-attribute (e.g. (Random)) for which the value should
be read from the CS_MSBRANCH
field.
null
otherwise.
M4Exception
public java.lang.String getMsbInfoWithoutAttrib(java.lang.String attributeName) throws M4Exception
String
omitting the equation for the
given attribute. If the attribute does not occur, the complete String
is returned. Note that an attribute is expected to occur at most once in the
MultiStepBranch-String
, because multiple occurences are redundant or
result in an empty Columnset
.
M4Exception,
- if the attributeName occurs in the
String
, but the substring is not properly ended by the character ';'.
M4Exception
public java.lang.String readOrComputeCount() throws M4Exception
M4Exception
public void updateStatistics() throws M4Exception
Column
s of this
Columnset
is performed.
M4Exception
public void clearStatistics() throws M4Exception
M4Exception
public Relation getRelation()
null
public void setRelation(Relation newRelation) throws M4Exception
newRelation
- The Relation to set
M4Exception
public Column createColumn(java.lang.String name, java.lang.String datatype) throws M4Exception
CreateException
- when an error occurs during creation of the object.
NameExistsException
- when the provided name already exists.
M4Exception
public void createColumnsFromDbObject(java.lang.String nameOfTableOrView) throws M4Exception
nameOfTableOrView
- name of the table or view
M4Exception
public Column getColumn(java.lang.String columnName) throws M4Exception
M4Exception
public ForeignKey createForeignKeyWhereThisIsFkCs(java.lang.String name) throws M4Exception
M4Exception
public ForeignKey getForeignKeyWhereThisIsFkCs(java.lang.String keyName) throws M4Exception
M4Exception
public void removeForeignKeyWhereThisIsFkCs(java.lang.String name) throws M4Exception
M4Exception
public void removeAllForeignKeys() throws M4Exception
M4Exception
public PrimaryKey createPrimaryKey(java.lang.String name) throws M4Exception
CreateException
- when an error occurs during creation of the object.
NameExistsException
- when the provided name already exists.
M4Exception
public void setPrimaryKey(PrimaryKey primaryKey) throws M4Exception
M4Exception
public void removePrimaryKey() throws M4Exception
M4Exception
public Columnset copy(Concept newConcept) throws M4Exception
M4Exception
public PrimaryKey getPrimaryKey() throws M4Exception
M4Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |