org.newsml.toolkit
Interface Comment

All Superinterfaces:
BaseNode, IdNode, IdText, LanguageNode, Text

public interface Comment
extends IdText, LanguageNode

A comment node in a NewsML document.

Many different element types in a NewsML document can have prose comments attached, possibly in multiple languages. These are not to be confused with XML comments (<!-- ... -->), which are discarded during import.

Version:
2.0
Author:
Reuters PLC

Method Summary
 Comment getReferencedComment()
          Get the comment referenced by TranslationOf.
 Text getTranslationOf()
          Get the identifier of another comment translated by this one.
 
Methods inherited from interface org.newsml.toolkit.Text
setBoolean, setInt, setString, toBoolean, toInt, toString
 
Methods inherited from interface org.newsml.toolkit.BaseNode
getAttr, getChild, getChild, getChild, getChild, getChildCount, getChildCount, getParent, getPath, getSession, getXMLName, getXPath, insertAfter, insertAfter, insertAfter, insertAfter, insertAfterDuid, insertAfterDuid, insertBefore, insertBefore, insertBefore, insertBefore, insertBeforeDuid, insertBeforeDuid, insertChild, insertChild, insertFirst, insertFirst, insertLast, insertLast, removeChild, removeChild, removeSelf, replaceChild, replaceChild, replaceChild, replaceChild, replaceChild, replaceChild, setAttr, setAttr, toXML, toXML, unsetAttr, unsetAttr, writeXML, writeXML
 
Methods inherited from interface org.newsml.toolkit.IdNode
getDuid, getEuid
 
Methods inherited from interface org.newsml.toolkit.LanguageNode
getLang
 

Method Detail

getTranslationOf

public Text getTranslationOf()
Get the identifier of another comment translated by this one.
Returns:
Text containing the Duid of the original version of this comment.
See Also:
getReferencedComment()

getReferencedComment

public Comment getReferencedComment()
                             throws IOException
Get the comment referenced by TranslationOf.
Returns:
The referenced comment, or null if not found.
Throws:
NewsMLException - if the referenced node is not a comment.
See Also:
getTranslationOf()