eu.bandm.tools.message

Class XMLDocumentIdentifier

java.lang.Object

eu.bandm.tools.message.XMLDocumentIdentifier

All Implemented Interfaces:

Formattable, Serializable, Cloneable, Comparable<XMLDocumentIdentifier>

public class XMLDocumentIdentifier
extends Object
implements Serializable, Cloneable, Comparable<XMLDocumentIdentifier>, Formattable

realizes a pair of identifiers ("system" and "public") as oftenly required to identify an XML document. The "system" part is required, the "public" part is optional. Some documentation on its role in XML texts (for entity identification) is at http://www.w3.org/TR/xml11/#NT-ExternalID
The structure of a "system id" is meant to be an URI.
The structure of an "public id" is not defined here. TRADITIONALLY it is a "Formal Public Identifier" as defined in SGML (= ISO 8879:1986).
In Utilities there are further methods.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Function<XMLDocumentIdentifier,String>	getPublicId Deprecated. use "XMLDocumentIdentifier::getPublicId" instead.
static Function<XMLDocumentIdentifier,String>	getSystemId Deprecated. use "XMLDocumentIdentifier::getSystemId" instead.
static Set<Character>	publicIdAlphabet contains all characters allowed in public IDs

Fields inherited from interface eu.bandm.tools.format.Formattable

format

Constructor Summary

Constructors

Constructor and Description
XMLDocumentIdentifier(String systemId) create an instance with given systemId and a publicId==null
XMLDocumentIdentifier(@Opt String publicId, String systemId) create an instance with given systemId and publicId.
XMLDocumentIdentifier(@Opt String publicId, URI systemId) Currently for convenience only, executes "systemId.toString()".
XMLDocumentIdentifier(@Opt String publicId, URL systemId) Currently for convenience only, executes "systemId.toString()".

Method Summary

Modifier and Type	Method and Description
int	compareTo(XMLDocumentIdentifier x) First compare the publicIds and, if equal, then the systemIds.
boolean	equals(Object o)
protected boolean	equals(XMLDocumentIdentifier x)
Format	format()
String	getPublicId()
String	getSystemId()
int	hashCode()
static boolean	isValidPublicId(String publicId) check if string is a valid public id.
static boolean	isValidSystemId(String systemId) check if string is a valid system id.
String	toString() Create string representation needed for XML headers.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

getPublicId

@Deprecated
public static final Function<XMLDocumentIdentifier,String> getPublicId

Deprecated. use "XMLDocumentIdentifier::getPublicId" instead.

getSystemId

@Deprecated
public static final Function<XMLDocumentIdentifier,String> getSystemId

Deprecated. use "XMLDocumentIdentifier::getSystemId" instead.

publicIdAlphabet

public static final Set<Character> publicIdAlphabet

contains all characters allowed in public IDs

Constructor Detail

XMLDocumentIdentifier

public XMLDocumentIdentifier(String systemId)

create an instance with given systemId and a publicId==null

XMLDocumentIdentifier

public XMLDocumentIdentifier(@Opt
                             @Opt String publicId,
                             String systemId)

create an instance with given systemId and publicId.

Throws:

IllegalArgumentException - iff systemId is null.

XMLDocumentIdentifier

public XMLDocumentIdentifier(@Opt
                             @Opt String publicId,
                             URI systemId)

Currently for convenience only, executes "systemId.toString()".

XMLDocumentIdentifier

public XMLDocumentIdentifier(@Opt
                             @Opt String publicId,
                             URL systemId)

Currently for convenience only, executes "systemId.toString()".

Method Detail

getPublicId

public final String getPublicId()

getSystemId

public final String getSystemId()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

Returns:

true iff

• some publicId is present and they are equal, or
• no public Id is present and systemId are equal.
Implies: missing system id is missing information, not inconsistency. No two XMLDocumentIdentifier with same system id carry different public ids.

equals

protected boolean equals(XMLDocumentIdentifier x)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Create string representation needed for XML headers. This format is rather awkward:
(a) if there is NO public Id, then print "SYSTEM <systemId>"
(b) if there IS a public Id, print "PUBLIC <publicId> <systemId>"
cf. http://www.w3.org/TR/xml11/#NT-ExternalID ATTENTION: both ids may contain EITHER single quote OR double quote, but not both. This will result in an IllegalArgumentException.

Overrides:

toString in class Object

format

public Format format()

Specified by:

format in interface Formattable

compareTo

public int compareTo(XMLDocumentIdentifier x)

First compare the publicIds and, if equal, then the systemIds. An object with publicId==null is smaller than one with publicId!=null.

Specified by:

compareTo in interface Comparable<XMLDocumentIdentifier>

isValidSystemId

public static boolean isValidSystemId(String systemId)

check if string is a valid system id. This is not done automatically, e.g. on cosntruction.

isValidPublicId

public static boolean isValidPublicId(String publicId)

check if string is a valid public id. This is not done automatically, e.g. on cosntruction.