org.activemath.omdocjdom
Class OJref

java.lang.Object
  org.jdom.Content
      org.jdom.Element
          org.activemath.omdocjdom.OJElement
              org.activemath.omdocjdom.OJref

All Implemented Interfaces:

Serializable, Cloneable, Infoable, OJNode, PointerElement, org.jdom.Parent

public class OJref
extends OJElement
implements PointerElement

Objects of these classes represent ref elements of OMdoc.

Version:

See Also:

Serialized Form

Field Summary

static String	NAME
protected ID	targetID

Fields inherited from class org.activemath.omdocjdom.OJElement

DEBUG, id, info, log

Fields inherited from class org.jdom.Element

additionalNamespaces, name, namespace

Fields inherited from class org.jdom.Content

parent

Constructor Summary

OJref()

OJref(org.jdom.Element srcElt)
A generic cloning method that clones all the attributes but within an OJref element, note that this method may behave badly with ref-target caching.

OJref(String stringID)
Objects built this way make <ref xref="stringID"> type of elements.

Method Summary

ID	getTargetID() Returns the target ID.
String	getXref()
void	setTargetID(ID id) Makes this object that the element pointed by is the element of the given ID.
void	setTheoryAndName(String theory, String name)
void	setXref(String r)

Methods inherited from class org.activemath.omdocjdom.OJElement

addContentMaybeCloning, addContentMaybeCloning, addContentMaybeCloning, addContentMaybeCloning, addContentMaybeCloning, addDCmetadata, addProperlyIndented, addProperlyIndented, clearExtraNamespaces, findChildWithID, getAnyTitle, getAnyTitle, getChildrenRefs, getCompleteDCMetadata, getContainingItem, getContainingTheory, getContainingTheoryIDstring, getCreator, getEnclosingID, getFirstDCMetadata, getID, getIndentOfElementWithNL, getInfo, getLanguage, getNL, getOrMakeMetadata, getorMakeMetadataExtradata, getParentOJElement, getRealContent, getTitle, getTitleMap, getTitleMapAsJdomElts, getTitleMapAsJdomNodeList, getTitleMapAsXmlString, getUnionOfDCMetadataEntries, listItems, setID, setID, setInfo, setNamespace, toString

Methods inherited from class org.jdom.Element

addContent, addContent, addContent, addContent, addContent, addNamespaceDeclaration, clone, cloneContent, getAdditionalNamespaces, getAttribute, getAttribute, getAttributes, getAttributeValue, getAttributeValue, getAttributeValue, getAttributeValue, getChild, getChild, getChildren, getChildren, getChildren, getChildText, getChildText, getChildTextNormalize, getChildTextNormalize, getChildTextTrim, getChildTextTrim, getContent, getContent, getContent, getContentSize, getDescendants, getDescendants, getName, getNamespace, getNamespace, getNamespacePrefix, getNamespaceURI, getQualifiedName, getText, getTextNormalize, getTextTrim, getValue, indexOf, isAncestor, isRootElement, removeAttribute, removeAttribute, removeAttribute, removeChild, removeChild, removeChildren, removeChildren, removeContent, removeContent, removeContent, removeContent, removeNamespaceDeclaration, setAttribute, setAttribute, setAttribute, setAttributes, setAttributes, setContent, setContent, setContent, setContent, setName, setText

Methods inherited from class org.jdom.Content

detach, equals, getDocument, getParent, getParentElement, hashCode, setParent

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.activemath.omdocjdom.OJNode

getDocument, getParent

Methods inherited from interface org.jdom.Parent

getDocument, getParent

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

targetID

protected ID targetID

Constructor Detail

OJref

public OJref()

OJref

public OJref(String stringID)

Objects built this way make <ref xref="stringID"> type of elements.

OJref

public OJref(org.jdom.Element srcElt)

A generic cloning method that clones all the attributes but within an OJref element, note that this method may behave badly with ref-target caching.

Method Detail

setTheoryAndName

public void setTheoryAndName(String theory,
                             String name)

setXref

public void setXref(String r)

getXref

public String getXref()

setTargetID

public void setTargetID(ID id)

Makes this object that the element pointed by is the element of the given ID.

getTargetID

public ID getTargetID()

Returns the target ID.

Specified by:

getTargetID in interface PointerElement

Throws:

InvalidID - in case the default collection is not specified