org.newsml.toolkit
Interface IdNode

All Known Subinterfaces:
AdministrativeMetadata, AssignedFormalName, AssignedOriginText, AssignedText, BasisForChoice, Catalog, Characteristics, Comment, ContentItem, Copyright, DefaultVocabularyFor, Description, DescriptiveMetadata, FormalName, FormalNameDecl, Identification, Instruction, Label, Metadata, NewsComponent, NewsEnvelope, NewsItem, NewsItemRef, NewsLine, NewsLines, NewsManagement, NewsML, OfInterestTo, Origin, OriginNode, OriginText, Party, PartyList, PrimaryNode, Property, Resource, RevisionHistory, RevisionId, RevisionStatus, RightsMetadata, SourceList, StatusWillChange, SubjectCode, Text, Topic, TopicSet, TopicSetRef, TransmissionId, UsageRights

public interface IdNode

Base node for identifiable NewsML objects.

Most NewsML objects can have a Duid (document-unique identifiers) and/or Euid (element-unique identifier) attached. All such objects are derived from this class.

Version:
1.0
Author:
Reuters PLC

Method Summary
 java.lang.String getDuid()
          Get the Duid for this element.
 java.lang.String getEuid()
          Get the Euid for this element.
 

Method Detail

getDuid

public java.lang.String getDuid()
Get the Duid for this element. The Duid, or Document-Unique Identifier, is a string identifier guaranteed to be unique within this NewsML package. Duids are heavily used for cross-referencing. Note that this method will always return null for instances of the NewsIdentifier, RevisionId, and TopicUse classes.
Returns:
The document-unique identifier for the underlying XML element, or null if none was specified.

getEuid

public java.lang.String getEuid()
Get the Euid for this element. The Euid, or Element-Unique Identifier is not likely to be used widely -- it's an identifier that unique only among elements with the same type and parent (and thus, is virtually useless for cross-referencing). This toolkit includes access to the Euid simply for the sake of completeness, but all of its retrieval and cross-referencing support is based on the Duid. Note that this method will always return null for instances of the NewsIdentifier, RevisionId, and TopicUse classes.
Returns:
The element-unique identifier for the underlying XML element, or null if none was specified.