|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmt.edu.um.nlgapp.docplan.DocPlan
public class DocPlan
This is the class for a document plan. A document plan has the form of a
tree, where each node (which is itself a DocPlan
) has a
relationship to its parent (null
by default), and an ontology
instance, which represents the message at that particular node. It also has a
status, a value from DocStatus
, which
indicates whether the current node is a document, a section, a paragraph or a
sentence. DocPlan nodes also have a
LexicalTemplate
, which should be set via calls to
Microplanner.microplanDoc(DocPlan)
;
Constructor Summary | |
---|---|
DocPlan()
Default (empty) constructor |
Method Summary | |
---|---|
void |
addChild(DocPlan child)
Add a child to this document plan. |
void |
addChild(DocPlan child,
java.lang.String parentRelation)
Add a child to this document plan, also specifying what the relation should be between the child and the current node (e.g. |
java.util.List<DocPlan> |
getChildren()
|
LexicalTemplate |
getLexicalTemplate()
|
uk.ac.abdn.carados.OntologyInstanceHandler |
getMessage()
|
DocPlan |
getParent()
|
java.lang.String |
getRelationToParent()
|
DocStatus |
getStatus()
|
void |
setChildren(java.util.List<DocPlan> children)
|
void |
setLexicalTemplate(LexicalTemplate template)
Set the lexical template corresponding to the message in this node; |
void |
setMessage(uk.ac.abdn.carados.OntologyInstanceHandler message)
|
void |
setRelationToParent(java.lang.String relationToParent)
|
void |
setStatus(DocStatus status)
Set the status of this document node, indicating what its |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DocPlan()
Method Detail |
---|
public DocStatus getStatus()
public void setStatus(DocStatus status)
status
- the status to setpublic uk.ac.abdn.carados.OntologyInstanceHandler getMessage()
public void setMessage(uk.ac.abdn.carados.OntologyInstanceHandler message)
message
- the message to setpublic java.lang.String getRelationToParent()
public void setRelationToParent(java.lang.String relationToParent)
relationToParent
- the relationToParent to setpublic DocPlan getParent()
null
if, and only if, the current node is the root
of the document.public java.util.List<DocPlan> getChildren()
public void setChildren(java.util.List<DocPlan> children)
children
- the children to setpublic void addChild(DocPlan child)
child
- The childpublic void addChild(DocPlan child, java.lang.String parentRelation)
child
- The childpublic void setLexicalTemplate(LexicalTemplate template)
template
- the templatepublic LexicalTemplate getLexicalTemplate()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |