org.tm4j.net
Interface FPILocator

All Superinterfaces:

Locator

public interface FPILocator

extends Locator

Defines a locator that represents a Formal Public Identifier (FPI). The most commonly-encountered FPI in XML Topic Maps is that of the XTM 1.0 DTD:

     -//TopicMaps.Org//DTD XML Topic Maps (XTM) 1.0//EN 

The definitions in SGML, XML, and ISO/IEC 9070 for the various forms of Formal Public Identifiers include possibilities more complex than described here. This interface is designed for SGML and XML-style FPIs (as defined in production [79] of ISO 8879 SGML). The first of three forms is recognizable as most commonly used on the Web:

      ownerId "//" publicTextClass SPACE publicTextDesc "//" publicTextLang
 

where (SGML productions are shown in square brackets):

ownerId [80]

The owner identifier, including surrounding syntax, e.g., "-//TopicMaps.Org//". This includes three types: registered, unregistered and ISO owner identifier strings. Unregistered owner IDs begin with "-//", registered with "+//" and ISO with "ISO".

publicTextClass [86]

The public text class, a mnemonic indicating the type of entity, e.g., "DTD". Other classes include: CAPACITY, CHARSET, DOCUMENT, DTD, ELEMENTS, ENTITIES, LPD, NONSGML, NOTATION, SHORTREF, SUBDOC, SYNTAX, TEXT. (Those commonly encountered in practice are shown in bold.)

publicTextDesc [87]

The text description of the entity, e.g., "XML Topic Maps (XTM) 1.0".

publicTextLang [88]

An indicator of the natural language of the entity, e.g., "EN" (English), an uppercase value from the ISO two character codes for language (ISO 639).

Note: more arcane FPI features such as "public text designating sequence" [89] or "public text display version" [90] are not considered as supported by this interface, and their character sequences may be be returned as part of existing methods rather than throwing exceptions. Extensions to this interface should make clear their level of support for these features.

Since:

0.8.2

Author:

Murray Altheim

Method Summary

java.lang.String	getOwnerIdentifier() Returns the owner identifier String.
java.lang.String	getPublicTextClass() Returns a String mnemonic for one of the permitted public text classes.
java.lang.String	getPublicTextDescription() Returns a String containing the public text description.
java.lang.String	getPublicTextLanguage() Returns a String containing the public text language.

Methods inherited from interface org.tm4j.net.Locator

copy, equals, getAddress, getFactory, getNotation, hashCode, initialise, resolveRelative, resolveRelative, setFactory

Method Detail

getOwnerIdentifier

public java.lang.String getOwnerIdentifier()

Returns the owner identifier String. This will include surrounding syntax, e.g., "-//IETF//", "-//TopicMaps.Org//".

Returns:

A string containing the FPI owner identifier.

getPublicTextClass

public java.lang.String getPublicTextClass()

Returns a String mnemonic for one of the permitted public text classes. E.g., "DOCUMENT", "DTD", "TEXT".

Returns:

A string containg the PFI public text class.

getPublicTextDescription

public java.lang.String getPublicTextDescription()

Returns a String containing the public text description. E.g., "HTML 2.0", "XML Topic Maps (XTM) 1.0".

Returns:

A string containg the FPI public text class.

getPublicTextLanguage

public java.lang.String getPublicTextLanguage()

Returns a String containing the public text language. E.g., "EN", "FR", "DE".

Returns:

A string containg the FPI public text language.