org.newsml.toolkit
Interface AssignmentNode

All Known Subinterfaces:

AssignedFormalName, AssignedOriginText, AssignedText, Copyright, DescriptiveMetadata, OfInterestTo, Origin, Property, RightsMetadata, SubjectCode, TopicOccurrence, UsageRights

public interface AssignmentNode

Interface for nodes with assignment information.

This is a common base interface for other interfaces, capturing common sets of access methods for assignment and responsibility information. It parallels the %assignment; parameter entity in the NewsML XML DTD.

Version:

2.0

Author:

Reuters PLC

Method Summary

Text	getAssignedBy() Get the party assigning the information.
Text	getAssignmentDateAndTime() Get the date and time of assignment.
FormalName	getConfidence() Get the confidence assigned to the information.
FormalName	getHowPresent() Get the applicability of the information.
FormalName	getImportance() Get the importance assigned to the information.

Method Detail

getAssignedBy

public Text getAssignedBy()

Get the party assigning the information.

The return value of this method may be general prose text (intended for human consumption) or a fragment identifier, beginning with '#', intended to allow a computer to look up a Topic by Duid. Obviously, there is room for confusion; for example, if an editor were identified by a number, as in "#S45674", a system might misinterpret that as a fragment identifier and try to look up the corresponding Topic. BEWARE!.

If a client application is fairly certain that the text does contain a fragment identifier and wants to locate the corresponding Topic, it can use the NewsMLSession.getNodeByDuid(java.lang.String) in the NewsMLSession interface (available through BaseNode.getSession()).

Returns:

A text node containing freeform text or a fragment identifier (starting with '#') pointing to a topic.

getImportance

public FormalName getImportance()

Get the importance assigned to the information.

The formal name returned will never have a local scheme or vocabulary, but it may have a default one.

Returns:

Text representing the local part of a formal name.

getConfidence

public FormalName getConfidence()

Get the confidence assigned to the information.

The formal name returned will never have a local scheme or vocabulary, but it may have a default one.

Returns:

Text representing the local part of a formal name.

getHowPresent

public FormalName getHowPresent()

Get the applicability of the information.

The formal name returned will never have a local scheme or vocabulary, but it may have a default one.

Returns:

Text representing the local part of a formal name.

getAssignmentDateAndTime

public Text getAssignmentDateAndTime()

Get the date and time of assignment.

Renamed to avoid confusion with date and time element, where present.

Returns:

Text containing the date in ISO 8601 basic format.