class Poco::XML::Name

Overview

An XML element or attribute name, consisting of a qualified name, a namespace URI and a local name. More…

#include <Name.h>

class Name
{
public:
    // fields

    static const XMLString EMPTY_NAME;

    // construction

    Name();
    Name(const XMLString& qname);

    Name(
        const XMLString& qname,
        const XMLString& namespaceURI
        );

    Name(
        const XMLString& qname,
        const XMLString& namespaceURI,
        const XMLString& localName
        );

    Name(const Name& name);

    // methods

    Name&
    operator=(const Name& name);

    void
    swap(Name& name);

    void
    assign(const XMLString& qname);

    void
    assign(
        const XMLString& qname,
        const XMLString& namespaceURI
        );

    void
    assign(
        const XMLString& qname,
        const XMLString& namespaceURI,
        const XMLString& localName
        );

    bool
    equals(const Name& name) const;

    bool
    equals(
        const XMLString& qname,
        const XMLString& namespaceURI,
        const XMLString& localName
        ) const;

    bool
    equalsWeakly(
        const XMLString& qname,
        const XMLString& namespaceURI,
        const XMLString& localName
        ) const;

    const XMLString&
    qname() const;

    const XMLString&
    namespaceURI() const;

    const XMLString&
    localName() const;

    XMLString
    prefix() const;

    static
    void
    split(
        const XMLString& qname,
        XMLString& prefix,
        XMLString& localName
        );

    static
    XMLString
    localName(const XMLString& qname);

    static
    XMLString
    prefix(const XMLString& qname);
};

Detailed Documentation

An XML element or attribute name, consisting of a qualified name, a namespace URI and a local name.

Construction

Name()

Creates an empty Name.

Name(const XMLString& qname)

Creates a Name from a qualified name only.

Name(
    const XMLString& qname,
    const XMLString& namespaceURI
    )

Creates a Name from a qualified name and a namespace URI.

The local name is extracted from the qualified name.

Name(
    const XMLString& qname,
    const XMLString& namespaceURI,
    const XMLString& localName
    )

Creates a Name from a qualified name, a namespace URI and a local name.

Name(const Name& name)

Copy constructor.

Methods

Name&
operator=(const Name& name)

Assignment operator.

void
swap(Name& name)

Swaps the name with another one.

void
assign(const XMLString& qname)

Assigns a new value to the name.

void
assign(
    const XMLString& qname,
    const XMLString& namespaceURI
    )

Assigns new values to the name.

The local name is extracted from the qualified name.

void
assign(
    const XMLString& qname,
    const XMLString& namespaceURI,
    const XMLString& localName
    )

Assigns new values to the name.

bool
equals(const Name& name) const

Returns true if both names are equal.

bool
equals(
    const XMLString& qname,
    const XMLString& namespaceURI,
    const XMLString& localName
    ) const

Returns true if all the name’s components are equal to the given ones.

bool
equalsWeakly(
    const XMLString& qname,
    const XMLString& namespaceURI,
    const XMLString& localName
    ) const

Returns true if either the qnames are identical or the namespaceURIs and the localNames are identical.

const XMLString&
qname() const

Returns the qualified name.

const XMLString&
namespaceURI() const

Returns the namespace URI.

const XMLString&
localName() const

Returns the local name.

XMLString
prefix() const

Returns the namespace prefix.

static
void
split(
    const XMLString& qname,
    XMLString& prefix,
    XMLString& localName
    )

Splits the given qualified name into its prefix and localName parts.

static
XMLString
localName(const XMLString& qname)

Returns the local name part of the given qualified name.

static
XMLString
prefix(const XMLString& qname)

Returns the prefix part of the given qualified name.