|
||||||||||
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.Key
This class represents an M4 Key. Its concrete subclasses are ForeignKey and PrimaryKey.
Field Summary | |
static java.lang.String |
ATTRIB_HEAD_FK_CS
|
static java.lang.String |
ATTRIB_HEAD_ID
|
static java.lang.String |
ATTRIB_HEAD_NAME
|
static java.lang.String |
ATTRIB_HEAD_PK_CS
|
static java.lang.String |
M4_TABLE_NAME
|
static M4Info |
m4Info
Cache for getM4Info() |
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 | |
Key(DB m4Db)
Constructor for Key. |
Method Summary | |
protected void |
addMember(KeyMember newMember)
Add a new KeyMember to this Keyhead. |
void |
deleteSoon()
Overwrites the superclass method because the members of this key must be deleted, too. |
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. |
abstract Columnset |
getForeignKeyColumnset()
|
java.lang.String |
getIdAttributeName()
|
M4Info |
getM4Info()
|
java.lang.String |
getM4TableName()
|
java.util.Collection |
getMembers()
Get all Members of this Keyhead. |
abstract Columnset |
getPrimaryKeyColumnset()
|
M4Info |
getXmlInfo()
|
abstract void |
primitiveSetForeignKeyColumnset(Columnset fkCs)
|
abstract void |
primitiveSetPrimaryKeyColumnset(Columnset pkCs)
|
void |
print()
Used to print information about this object. |
void |
removeAllColumns()
|
protected void |
removeAllM4References()
This method needs to be implemented by all M4Data
objects. |
abstract void |
removeColumn(java.lang.String name)
Removing a Column from the Key, but not from the Columnset the Column belongs to. |
protected void |
removeMemberByForeignColumnName(java.lang.String name)
Removes that KeyMember whose foreign key Column has the given name from this KeyHead (without deleting it). |
protected void |
removeMemberByPrimaryColumnName(java.lang.String name)
Removes that KeyMember whose primary key Column has the given name from this KeyHead (without deleting it). |
protected void |
removeMembers()
Remove all KeyMembers from this KeyHead. |
abstract void |
setForeignKeyColumnset(Columnset fkCs)
|
protected void |
setMembers(java.util.Collection newMembers)
Associate this Key with the given Collection of KeyMembers. |
abstract void |
setPrimaryKeyColumnset(Columnset pkCs)
|
Methods inherited from class edu.udo.cs.miningmart.m4.core.M4Data |
deleteLocal, exportLocal, genericGetter, genericSetter, getDocumentation, getObjectsInNamespace, getObjectsReferencingMe, getObjectsReferencingMe, getObjectTag, getValidName, getXmlIdTag, getXmlVersion, hasDeleteStatus, importLocal, isDirty, isWaitingForDelete, primitiveGetDocObject, primitiveSetDocObject, readFromDb, readFromDbLocal, removeDocObject, removeFromDb, removeSetFromDb, setDirty, setDocumentation, setId, setName, storeLocal, 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.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_NAME
public static final java.lang.String ATTRIB_HEAD_ID
public static final java.lang.String ATTRIB_HEAD_NAME
public static final java.lang.String ATTRIB_HEAD_PK_CS
public static final java.lang.String ATTRIB_HEAD_FK_CS
public static M4Info m4Info
Constructor Detail |
public Key(DB m4Db)
m4Db
- edu.udo.cs.miningmart.m4.core.M4Object#Constructor
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()
print
in interface M4Object
print
in class M4Object
M4Object.print()
public abstract void setPrimaryKeyColumnset(Columnset pkCs) throws M4Exception
setPrimaryKeyColumnset
in interface Key
M4Exception
public abstract void setForeignKeyColumnset(Columnset fkCs) throws M4Exception
setForeignKeyColumnset
in interface Key
M4Exception
public abstract void primitiveSetPrimaryKeyColumnset(Columnset pkCs) throws M4Exception
M4Exception
public abstract void primitiveSetForeignKeyColumnset(Columnset fkCs) throws M4Exception
M4Exception
public abstract Columnset getPrimaryKeyColumnset() throws M4Exception
getPrimaryKeyColumnset
in interface Key
M4Exception
public abstract Columnset getForeignKeyColumnset() throws M4Exception
getForeignKeyColumnset
in interface Key
M4Exception
protected void addMember(KeyMember newMember) throws M4Exception
M4Exception
KeyMember
protected void removeMemberByPrimaryColumnName(java.lang.String name) throws M4Exception
name
- The name
M4Exception
protected void removeMemberByForeignColumnName(java.lang.String name) throws M4Exception
name
- The name
M4Exception
public java.util.Collection getMembers() throws M4Exception
Collection
of KeyMember
s.
M4Exception
protected void removeMembers()
protected void setMembers(java.util.Collection newMembers) throws M4Exception
newMembers
- a Collection
of KeyMember
s
M4Exception
public void deleteSoon() throws M4Exception
deleteSoon
in interface M4Data
deleteSoon
in class M4Data
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()
public java.util.Collection getDependentObjects() throws M4Exception
M4Data
M4Data
sub-classes that need to be serialized.
getDependentObjects
in interface XmlInfo
getDependentObjects
in class M4Data
Collection
of all M4Data
Java objects
holding a foreign key reference to this
object.
This method must never return null
.
M4Exception
M4Data.getDependentObjects()
public abstract void removeColumn(java.lang.String name) throws M4Exception
M4Exception
public void removeAllColumns() throws M4Exception
M4Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |