org.newsml.toolkit
Interface Identification

All Superinterfaces:

BaseNode, IdNode

public interface Identification

extends BaseNode, IdNode

Identification labels for a NewsItem

Version:

2.0

Author:

Reuters PLC

Method Summary

IdText	getDateLabel() Get the optional date label.
Label[]	getLabel() Get an array of all available labels.
Label	getLabel(int index) Get a generic label.
int	getLabelCount() Count the generic labels.
IdText	getNameLabel() Get the optional name label.
NewsIdentifier	getNewsIdentifier() Get the identification information for this news item.

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

getNewsIdentifier

public NewsIdentifier getNewsIdentifier()

Get the identification information for this news item. The identification information allows you to determine which news items are new and which are updated versions of previous ones.

Returns:

An object containing the identification information (not null).

getNameLabel

public IdText getNameLabel()

Get the optional name label.

Returns:

A text object representing the name label, or null if none was provided.

getDateLabel

public IdText getDateLabel()

Get the optional date label.

Returns:

A text object representing the date label, or null if none was provided.

getLabelCount

public int getLabelCount()

Count the generic labels.

Returns:

The number of generic labels present.

getLabel

public Label getLabel(int index)

Get a generic label.

Parameters:

index - The position of the label, zero-based, numbered sequentially.

Returns:

A text object representing the name label, or null if none was provided at the index specified.

getLabel

public Label[] getLabel()

Get an array of all available labels.

Returns:

A (possibly empty) array of labels.