All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class pmr.sgml.SGMLNode

java.lang.Object
   |
   +----pmr.sgml.SGMLNode

public class SGMLNode

extends Object

Author:

(C) P. Murray-Rust, 1996

attribs

child

childrenHiddenManually

color

content

contentNode

Some SGMLNodes are just containers for others - a contentNode is one such

drawableSGMLNodes

DrawableSGMLNodes which refer to this node

gi

giName

hiddenManually

index

nattribs

nchild

nchildbuf

nodeType

parent

PRINT_ESIS

PRINT_HTML

processed

searchKey

title

tree

inheritable by subclasses NOT in pmr.sgml

validContent

visible

whichChild

SGMLNode()

SGMLNode(SGMLNode)

'copy' constructor - NOT recursive, just copies references

SGMLNode(String, SGMLTree)

nt = "_PEL", "_DOCROOT", or is the GI

addChild(int)

the parent may react to adding a child; usually subclassed

addChild(int, SGMLNode)

add a child newNode at childIndex (runs from 0 to nchild); values outside this throw exception

addContent(String)

addDrawableSGMLNode(DrawableSGMLNode)

addGIName(String)

addNode(SGMLNode)

add a pre-formed node to this; returns index

addSGMLAttlist(SGMLAttlist)

addSGMLAttribute(SGMLAttribute)

adds SGMLAttribute, or replaces old value

addSGMLAttribute(String, String)

adds SGMLAttribute, or replaces old value

addTree(SGMLNode)

add a tree to a Node (as the last child.

areChildrenHidden()

are node's children hidden either by GI or by user?

areChildrenHiddenByGI()

are the children of this node hidden by virtue of this node's GI or GI context? To be overridden if required

childCount()

childrenToHTML()

returns (maybe recursively) the HTML representation of the children

childrenToString()

returns (maybe recursively) the SGML representation of the children

createPELandAdd(int, String)

add PEL node (often from subclasses); addes the current node (this) and also creates a PEL node from content which it then also adds

debug()

deleteNodeAndSubtree()

delete a node and all its descendants

deleteSubtree()

delete all descendants of a node

detachFromTree()

delete this but not its descendants

display()

display.

display(Graphics)

display a SGMLNode to Graphics provided from some other SGMLNode (e.g.

displayChildren(Graphics)

display all children.

displayChildrenRecursively(Graphics)

the same, but recurse

drawIcon(Graphics, int, int)

draws an icon based on the GI - crude at present!! Overridden by subclasses.

error(String)

I must replace this by exceptions...

getAncestors()

get all ancestors excluding current Node and DOCROOT

getAttval(String)

CoST: get SGMLAttribute value (if non-existent attribute, return "") attname is case-insensitive

getChildIndex(int)

getChildNode(int)

getChildrenHiddenManually()

are the children manually hidden; "YES", "NO", ""

getChildrenIndexSet()

children of node as SGMLNodeIndexSet

getColor()

color of SGMLNode text - overridden by subclasses?

getContent()

retrieves the String content (only for PEL nodes) else ""

getDescendants()

getDescendants(String)

subtree traversal - includes node; if no nodes found, return empty SGMLNodeIndexSet;

getFirstNode(String)

searches for a given Node or Nodes a la COST

getGI()

retrieves the complete GI associated with this node (cf.

getGIName()

getHiddenManually()

is the node manually hidden; "YES", "NO", ""

getIndex()

getNodeType()

getParentIndex()

getParentNode()

getSGMLAttlist()

getSGMLAttributeCount()

getSGMLAttributes()

getSGMLStream()

gets the SGMLStream for the node and subtree

getStringContent()

since PEL nodes are such a pain, this will retrieve the contents of a single PEL child if present

getTitle()

makes a suitable title for the node in following priority:

• content SGMLNode (any SGMLNode contained by this node and so defined by user
• TITLE attribute
• NAME attribute
• GI

getTree()

hasAttname(String)

CoST: does this node have attribute with name attname? (Case-insensitive)

hasAttval(String, String)

CoST: does this node have attribute with name attname (case-insensitive) and value attval (case-sensitive)?

hasChild()

true if node has 1 or more children

hasContent()

true if the node has String content (i.e.

hasGI(String)

CoST: does this node have GI g? (Case-insensitive)

highlight()

highlights node in some way (e.g.

importNodeAsLastChild(SGMLNode)

add the imported node as last child.

importNodeAsYoungerSibling(SGMLNode)

add the imported node as younger sibling.

isAncestorOf(SGMLNode)

is this an ancestor of n?

isHidden()

is node hidden either by GI or by user?

isHiddenByGI()

is the SGMLNode hidden by virtue of its GI or GI context? To be overrridden by subclasses if required

isProcessed()

has the SGMLNode been processed?

isValid()

processing may determine whether a SGMLNode has valid semantics or not

mayContain(SGMLNode)

check whether node may be added (e.g.

moveToBeLastChildOf(SGMLNode)

move the current node to be LastChild of parent

moveToBeYoungerSiblingOf(SGMLNode)

move the current node to be YoungerSibling of esib

nonPELChildCount()

outputSGML(File)

as toString(), but ouputs to file avoids memory problems???

prettyContent(String)

formats the string in<= 80 cols and deals with quotes ("")

print(int)

output node in way determined by printType.

process()

dummy - to be implemented by subClasses

sendSignal()

makeClickable - very speculative - sends signal to table of links UNDER DEVELOPMENT

setChildrenHiddenManually(String)

set the children manually hidden; "YES", "NO", ""

setContent(String)

set the content (be very careful).

setGrandChildrenHiddenManually()

set the grandchildren manually hidden; always YES

setHiddenManually(String)

set the node manually hidden; "YES", "NO", ""

setTitle(String)

taggedEventStream()

return all the PCDATA children (PEL) as a concatenated string with the tags (e.g.

toHTML()

returns (maybe recursively) the HTML representation of the node.

toString()

returns (maybe recursively) the SGML representation of the node.

transferSubtree(SGMLNode, int, int)

untaggedEventStream()

return all the PCDATA children (PEL) as a concatenated string without the tags (e.g.

whichChild()

which number of child in family (eldest = 0)

  protected SGMLTree tree

inheritable by subclasses NOT in pmr.sgml

  protected int index

  protected boolean processed

  protected int nchild

  protected int child[]

  protected boolean validContent

  protected String giName

  protected GI gi

  protected SGMLAttlist attribs

  protected int nattribs

  protected String content

  protected String nodeType

  protected int parent

  protected int nchildbuf

  protected int whichChild

  protected String title

  protected Color color

  protected boolean visible

  protected String hiddenManually

  protected String childrenHiddenManually

  protected Vector drawableSGMLNodes

DrawableSGMLNodes which refer to this node

  protected SGMLNode contentNode

Some SGMLNodes are just containers for others - a contentNode is one such

  protected final static int PRINT_ESIS

  protected final static int PRINT_HTML

  protected static String searchKey[]

  public SGMLNode()

  public SGMLNode(String nt,
                  SGMLTree tree)

nt = "_PEL", "_DOCROOT", or is the GI

  public SGMLNode(SGMLNode n)

'copy' constructor - NOT recursive, just copies references

  public int createPELandAdd(int parentIndex,
                             String content)

add PEL node (often from subclasses); addes the current node (this) and also creates a PEL node from content which it then also adds

  public int addNode(SGMLNode n)

add a pre-formed node to this; returns index

  public int addTree(SGMLNode n)

add a tree to a Node (as the last child. This will reassign all indexes and tree references in the subtree. The node n must have no parent; Node references in the original tree are set to null; (This is a waste of space, but probably tolerable until I remove the 'index' approach.

  public int transferSubtree(SGMLNode n,
                             int nodeIndex,
                             int level)

  public boolean mayContain(SGMLNode childNode)

check whether node may be added (e.g. compatible with DTD). Default is true, but subclassed to other Nodes witn constraints

  public void detachFromTree()

delete this but not its descendants

  public void deleteNodeAndSubtree()

delete a node and all its descendants

  public void deleteSubtree()

delete all descendants of a node

  public void addChild(int atChildIndex,
                       SGMLNode newChild) throws IllegalArgumentException, DTDViolationException, DifferentSGMLTreesException

add a child newNode at childIndex (runs from 0 to nchild); values outside this throw exception

Throws: DifferentSGMLTreesException

this and newNode have different trees

Throws: IllegalArgumentException

silly value of atChildIndex

Throws: DTDViolationException

child GI not allowed in parent

  public void moveToBeYoungerSiblingOf(SGMLNode esib) throws TreeViolationException, DTDViolationException, DifferentSGMLTreesException

move the current node to be YoungerSibling of esib

Throws: TreeViolationException

Cannot make ancestor child of descendant

Throws: DifferentSGMLTreesException

esib and this belong to different trees

Throws: DTDViolationException

document violates DTD

  public int importNodeAsYoungerSibling(SGMLNode n) throws IllegalArgumentException, DTDViolationException

add the imported node as younger sibling. This is done through an intermediate SGMLStream, which destroys any current state of importNode, but overrides the problem of different trees

Throws: DTDViolationException

document violates DTD

  public void moveToBeLastChildOf(SGMLNode newParent) throws TreeViolationException, DTDViolationException, DifferentSGMLTreesException

move the current node to be LastChild of parent

Throws: TreeViolationException

Cannot make ancestor child of descendant

Throws: DifferentSGMLTreesException

parent and this belong to different trees

Throws: DTDViolationException

document violates DTD

  public int importNodeAsLastChild(SGMLNode n) throws IllegalArgumentException, DTDViolationException

add the imported node as last child. This is done through an intermediate SGMLStream, which destroys any current state of importNode, but overrides the problem of different trees

Throws: DTDViolationException

document violates DTD

  public boolean isAncestorOf(SGMLNode n)

is this an ancestor of n?

  public void error(String s)

I must replace this by exceptions...

  public void addDrawableSGMLNode(DrawableSGMLNode d)

  public void addSGMLAttlist(SGMLAttlist attribs)

  public void addSGMLAttribute(String name,
                               String value)

adds SGMLAttribute, or replaces old value

  public void addSGMLAttribute(SGMLAttribute a)

adds SGMLAttribute, or replaces old value

  public void addGIName(String giName)

  public void addChild(int childIndex)

the parent may react to adding a child; usually subclassed

  public void addContent(String content)

  public SGMLAttribute[] getSGMLAttributes()

  public SGMLAttlist getSGMLAttlist()

  public int getSGMLAttributeCount()

  public SGMLTree getTree()

  public String getNodeType()

  public int getParentIndex()

  public SGMLNode getParentNode()

  public boolean isValid()

processing may determine whether a SGMLNode has valid semantics or not

  public boolean isProcessed()

has the SGMLNode been processed?

  public void process()

dummy - to be implemented by subClasses

  public boolean isHidden()

is node hidden either by GI or by user?

  public boolean isHiddenByGI()

is the SGMLNode hidden by virtue of its GI or GI context? To be overrridden by subclasses if required

  public boolean areChildrenHidden()

are node's children hidden either by GI or by user?

  public boolean areChildrenHiddenByGI()

are the children of this node hidden by virtue of this node's GI or GI context? To be overridden if required

  public void setHiddenManually(String s)

set the node manually hidden; "YES", "NO", ""

  public String getHiddenManually()

is the node manually hidden; "YES", "NO", ""

  public void setChildrenHiddenManually(String s)

set the children manually hidden; "YES", "NO", ""

  public String getChildrenHiddenManually()

are the children manually hidden; "YES", "NO", ""

  public void setGrandChildrenHiddenManually()

set the grandchildren manually hidden; always YES

  public SGMLNodeIndexSet getChildrenIndexSet()

children of node as SGMLNodeIndexSet

  public int childCount()

  public int nonPELChildCount()

  public int getIndex()

  public int whichChild()

which number of child in family (eldest = 0)

  public SGMLNode getChildNode(int i)

  public int getChildIndex(int i)

  public boolean hasGI(String g)

CoST: does this node have GI g? (Case-insensitive)

  public boolean hasAttname(String attname)

CoST: does this node have attribute with name attname? (Case-insensitive)

  public boolean hasAttval(String attname,
                           String attval)

CoST: does this node have attribute with name attname (case-insensitive) and value attval (case-sensitive)?

  public String getAttval(String attname)

CoST: get SGMLAttribute value (if non-existent attribute, return "") attname is case-insensitive

  public boolean hasChild()

true if node has 1 or more children

  public SGMLNodeIndexSet getAncestors()

get all ancestors excluding current Node and DOCROOT

  public SGMLNodeIndexSet getDescendants(String strategy)

subtree traversal - includes node; if no nodes found, return empty SGMLNodeIndexSet;

Parameters:

strategy - "DEPTH" or "BREADTH"

  public SGMLNodeIndexSet getDescendants()

  public boolean hasContent()

true if the node has String content (i.e. is a PEL node)

  public void setContent(String s)

set the content (be very careful). Only allowed for _PEL

  public String getContent()

retrieves the String content (only for PEL nodes) else ""

  public String getStringContent()

since PEL nodes are such a pain, this will retrieve the contents of a single PEL child if present

  public String untaggedEventStream()

return all the PCDATA children (PEL) as a concatenated string without the tags (e.g. "This <B>is</B>bold" renders as "This isbold"

For the complete event stream, use the taggedEventStream

  public String taggedEventStream()

return all the PCDATA children (PEL) as a concatenated string with the tags (e.g. "This <B>is</B>bold" renders as "This <B>is</B>bold"

For the event stream without tags, use the untaggedEventStream

  public String getGIName()

  public SGMLNode getFirstNode(String search)

searches for a given Node or Nodes a la COST

  public String getTitle()

makes a suitable title for the node in following priority:

• content SGMLNode (any SGMLNode contained by this node and so defined by user
• TITLE attribute
• NAME attribute
• GI

  public void setTitle(String title)

  public Color getColor()

color of SGMLNode text - overridden by subclasses?

  public GI getGI()

retrieves the complete GI associated with this node (cf. getGIName

  public void display()

display. This is coupled to GI display. many GIs map onto subclasses of SGMLNode and will have code provided. Alternatively it may be done through the GI itself...

  public int drawIcon(Graphics g,
                      int x,
                      int y)

draws an icon based on the GI - crude at present!! Overridden by subclasses. x, y are at bottom left (pixels) and remember that y goes DOWN the page when constructing your icon!

  public void displayChildren(Graphics g)

display all children. Haven't yet decided how to select which ones or lay them out. Early days. Probably translate them in y to avoid overlap

  public void displayChildrenRecursively(Graphics g)

the same, but recurse

  public void display(Graphics g)

display a SGMLNode to Graphics provided from some other SGMLNode (e.g. a container) Almost certainly overridden.

  public void print(int printType)

output node in way determined by printType. UNDER DEVELOPMENT

  public void highlight()

highlights node in some way (e.g. blink) UNDER DEVELOPMENT

  public void sendSignal()

makeClickable - very speculative - sends signal to table of links UNDER DEVELOPMENT

  public void debug()

  public SGMLStream getSGMLStream()

gets the SGMLStream for the node and subtree

  public String toString()

returns (maybe recursively) the SGML representation of the node. calls childrenToString(), which might be overridden by some SGMLNode types

Overrides:

toString in class Object

  public String childrenToString()

returns (maybe recursively) the SGML representation of the children

  public String toHTML()

returns (maybe recursively) the HTML representation of the node. calls childrenToHTML(), which might be overridden by some SGMLNode types

  public String childrenToHTML()

returns (maybe recursively) the HTML representation of the children

  public void outputSGML(File file) throws IOException

as toString(), but ouputs to file avoids memory problems???

  public static String prettyContent(String s)

formats the string in<= 80 cols and deals with quotes ("")

All Packages  Class Hierarchy  This Package  Previous  Next  Index