FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoXmlAttribute Class Reference

#include <Attribute.h>

Inherits FdoDictionaryElement.

Inheritance diagram for FdoXmlAttribute:

[legend]
List of all members.

Detailed Description

FdoXmlAttribute contains the name and value of a single attribute from an XML document.

Definition at line 27 of file Attribute.h.


Public Member Functions

FdoStringP GetLocalName ()
 Gets the attribute's local name.
FdoStringP GetLocalValue ()
 Gets the attribute's local value.
FdoStringP GetPrefix ()
 Gets the attribute's namespace prefix.
FdoStringP GetQName ()
 Gets the attribute's qualified name.
FdoStringP GetUri ()
 Gets the attribute's namespace URI.
FdoStringP GetValuePrefix ()
 Gets the attribute value's namespace prefix.
FdoStringP GetValueUri ()
 Gets the attribute value's namespace URI.

Static Public Member Functions

FDO_API_COMMON FdoXmlAttributeCreate (FdoString *name, FdoString *value, FdoString *localName=NULL, FdoString *uri=NULL, FdoString *prefix=NULL, FdoString *valueUri=NULL, FdoString *localValue=NULL, FdoString *valuePrefix=NULL)
 Constructs an XML Attribute object.

Protected Member Functions

 FdoXmlAttribute (FdoString *name, FdoString *value, FdoString *localName, FdoString *uri, FdoString *prefix, FdoString *valueUri, FdoString *localValue, FdoString *valuePrefix)
 FdoXmlAttribute ()
 DOXYGEN-IGNORE

Friends

class FdoCommonInternal

Constructor & Destructor Documentation

FdoXmlAttribute::FdoXmlAttribute  )  [inline, protected]
 

DOXYGEN-IGNORE

Definition at line 159 of file Attribute.h.

FdoXmlAttribute::FdoXmlAttribute FdoString name,
FdoString value,
FdoString localName,
FdoString uri,
FdoString prefix,
FdoString valueUri,
FdoString localValue,
FdoString valuePrefix
[protected]
 


Member Function Documentation

FDO_API_COMMON FdoXmlAttribute* FdoXmlAttribute::Create FdoString name,
FdoString value,
FdoString localName = NULL,
FdoString uri = NULL,
FdoString prefix = NULL,
FdoString valueUri = NULL,
FdoString localValue = NULL,
FdoString valuePrefix = NULL
[static]
 

Constructs an XML Attribute object.

Parameters:
name Input unique attribute name. If the attribute name is namespace qualified the name is {uri}:{localName}. Otherwise, it is {localName}
value Input attribute value.
localName Input attribute name without namespace qualification.
uri Input uri for the attribute namespace. L"" if the attribute name is not namespace qualified.
prefix Input prefix for the attribute namespace. L"" if the attribute name is not namespace qualified.
valueUri Input uri for the attribute value's namespace. L"" if the attribute value is not namespace qualified.
localValue Input attribute value without namespace qualification.
valuePrefix Input prefix for the attribute value's namespace. L"" if the attribute value is not namespace qualified.
Returns:
Returns FdoXmlAttribute

FdoStringP FdoXmlAttribute::GetLocalName  )  [inline]
 

Gets the attribute's local name.

Returns:
Returns FdoStringP. Same value is GetName() when attribute name not qualified by namespace

Definition at line 78 of file Attribute.h.

FdoStringP FdoXmlAttribute::GetLocalValue  )  [inline]
 

Gets the attribute's local value.

Returns:
Returns FdoStringP. Same value is GetValue() when attribute value is not qualified by namespace

Definition at line 126 of file Attribute.h.

FdoStringP FdoXmlAttribute::GetPrefix  )  [inline]
 

Gets the attribute's namespace prefix.

Returns:
Returns FdoStringP. L"" when attribute name not qualified by namespace

Definition at line 102 of file Attribute.h.

FdoStringP FdoXmlAttribute::GetQName  )  [inline]
 

Gets the attribute's qualified name.

Returns:
Returns {prefix}:{localName} when attribute name is qualified by namespace. Otherwise, returns the same value as GetLocalName().

Definition at line 150 of file Attribute.h.

References FdoStringP::GetLength().

Here is the call graph for this function:

FdoStringP FdoXmlAttribute::GetUri  )  [inline]
 

Gets the attribute's namespace URI.

Returns:
Returns FdoStringP. L"" when attribute name not qualified by namespace

Definition at line 90 of file Attribute.h.

FdoStringP FdoXmlAttribute::GetValuePrefix  )  [inline]
 

Gets the attribute value's namespace prefix.

Returns:
Returns FdoStringP. L"" when attribute value is not qualified by namespace

Definition at line 138 of file Attribute.h.

FdoStringP FdoXmlAttribute::GetValueUri  )  [inline]
 

Gets the attribute value's namespace URI.

Returns:
Returns FdoStringP. L"" when attribute value not qualified by namespace

Definition at line 114 of file Attribute.h.


Friends And Related Function Documentation

friend class FdoCommonInternal [friend]
 

Reimplemented from FdoDictionaryElement.

Definition at line 29 of file Attribute.h.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.