org.newsml.toolkit
Interface Encoding

All Superinterfaces:
BaseNode, IdNode

public interface Encoding
extends BaseNode, IdNode

An encoding step for raw inline content.

This class defines an encoding step performed on the raw, inline content. Exactly one of getEncoding() or getDataContent() will return a non-null value, as with ContentItem.

Version:
2.0
Author:
Reuters PLC

Method Summary
 DataContent getDataContent()
          Get the raw inline content.
 Encoding getEncoding()
          Get a further encoding step.
 Text getNotation()
          Get the notation for the data content.
 
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
 

Method Detail

getNotation

public Text getNotation()
Get the notation for the data content.

It is possible that this attribute value was intended to be treated as a formal name, but there is no explicit statement in the NewsML 1.0 Functional Specification or the DTD that says so.

Returns:
Text describing the notation for this encoding step.

getEncoding

public Encoding getEncoding()
Get a further encoding step.
Returns:
A futher encoding step, or null if none was provided (in which case getDataContent() will return a non-null value).

getDataContent

public DataContent getDataContent()
Get the raw inline content.
Returns:
An object containing the raw content, or null if a further encoding step is present (in which case getEncoding() will return a non-null value).