|
||||||||||
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.Docu
Instances of this class represent an entry in the table DOCU_T.
Field Summary | |
static java.lang.String |
ATTRIB_DOC_ID
DB level: The attribute storing the local docu IDs. |
static java.lang.String |
ATTRIB_OBJECT_ID
DB level: The attribute storing the doc-entry's object IDs. |
static java.lang.String |
ATTRIB_OBJECT_TYPE
DB level: The attribute storing the object types. |
static java.lang.String |
ATTRIB_TEXT
DB level: The attribute storing the documentation |
static java.lang.String |
M4_TABLE_NAME
The M4 table name storing documentation information. |
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 | |
Docu(DB m4Db)
Constructor for Docu. |
Method Summary | |
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 |
getIdAttributeName()
|
M4Info |
getM4Info()
|
M4Object |
getM4Object()
Returns the M4Object that this documentation entry belongs to. |
java.lang.String |
getM4TableName()
|
long |
getObjectId()
Returns the id of the M4 object associated with this documentation object. |
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. |
java.lang.String |
getObjectType()
Returns the type of the M4 object associated with this documentation object. |
java.lang.String |
getText()
Returns the actual documentation entry (the description String). |
M4Info |
getXmlInfo()
|
void |
primitiveSetM4Object(M4Data newM4Object)
Primitive setter. |
void |
print()
Method to print data about this M4Object. |
protected void |
removeAllM4References()
This method needs to be implemented by all M4Data
objects. |
void |
setM4Object(M4Data newM4Object)
Set the connection to the M4 object that this documentation object is associated with. |
void |
setObjectId(long id)
Sets the id of the M4 object associated with this documentation object. |
void |
setObjectType(java.lang.String type)
Sets the the type of the M4 object associated with this documentation object. |
void |
setText(java.lang.String newText)
Sets the text (the description String for the M4 Object that this Documentation object belongs to). |
Methods inherited from class edu.udo.cs.miningmart.m4.core.M4Data |
deleteLocal, deleteSoon, exportLocal, genericGetter, genericSetter, getDocumentation, 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 |
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, putM4ObjectToCache, replaceSpacesInName, setId, setName |
Field Detail |
public static final java.lang.String M4_TABLE_NAME
public static final java.lang.String ATTRIB_DOC_ID
public static final java.lang.String ATTRIB_OBJECT_ID
public static final java.lang.String ATTRIB_OBJECT_TYPE
public static final java.lang.String ATTRIB_TEXT
public static M4Info m4Info
Constructor Detail |
public Docu(DB m4Db)
m4Db
- 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 M4Object
M4Object.print()
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 M4Object getM4Object()
getM4Object
in interface Docu
public java.lang.String getText()
getText
in interface Docu
public void primitiveSetM4Object(M4Data newM4Object) throws M4Exception
newM4Object
- The new M4Object to set
M4Exception
public void setM4Object(M4Data newM4Object) throws M4Exception
setM4Object
in interface Docu
M4Exception
public void setText(java.lang.String newText)
setText
in interface Docu
newText
- The new text to setpublic long getObjectId()
getObjectId
in interface Docu
public java.lang.String getObjectType()
getObjectType
in interface Docu
public void setObjectId(long id) throws M4Exception
setObjectId
in interface Docu
id
- The id to set
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()
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
.M4Data.getDependentObjects()
public void setObjectType(java.lang.String type) throws M4Exception
setObjectType
in interface Docu
type
- The class of the M4 object.
M4Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |