org.newsml.toolkit
Interface BasisForChoice

All Superinterfaces:

BaseNode, IdNode, IdText, Text

public interface BasisForChoice

extends IdText

Basis for choosing among equivalent news components or content items.

When a NewsComponent is an equivalents list (see NewsComponent.getEquivalentsList()) it may provide one or more hints on how to select from the list. This interface provides an XPath to the relevant information (requiring, unfortunately, access to the full DOM tree) together with ranking information.

Note that the documentation does not specifically state that basis for choice can apply to an equivalents list of NewsItem or NewsItemRef members in a news component; use with caution until the IPTC clarifies the rules.

Version:

2.0

Author:

Reuters PLC

Method Summary

Text	getRank() Rank this basis for choice.

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

Method Detail

getRank

public Text getRank()

Rank this basis for choice.

To get the rank as an integer, use the return value's Text.toInt() method.

Returns:

Text containing an integer ranking this basis for choice among the others (a lower number indicates higher importance), or null if no explicit rank was provided.