XMLAttDef class Reference

| API Docs for SAX and DOM |

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# XMLAttDef Class Reference

Represents the core information of an atribute definition. More...

Inheritance diagram for XMLAttDef:

[legend]
Collaboration diagram for XMLAttDef:

[legend]
List of all members.

## Public Types

enum

AttTypes {
CData = 0, ID = 1, IDRef = 2, IDRefs = 3,
Entity = 4, Entities = 5, NmToken = 6, NmTokens = 7,
Notation = 8, Enumeration = 9, Simple = 10, Any_Any = 11,
Any_Other = 12, Any_List = 13, AttTypes_Count, AttTypes_Min = 0,
AttTypes_Max = 13, AttTypes_Unknown = -1
}

enum

DefAttTypes {
Default = 0, Fixed = 1, Required = 2, Required_And_Fixed = 3,
Implied = 4, ProcessContents_Skip = 5, ProcessContents_Lax = 6, ProcessContents_Strict = 7,
Prohibited = 8, DefAttTypes_Count, DefAttTypes_Min = 0, DefAttTypes_Max = 8,
DefAttTypes_Unknown = -1
}

enum | CreateReasons { NoReason, JustFaultIn }

## Public Methods

Destructor
virtual | ~XMLAttDef ()
| Destructor.
Virtual interface
virtual const XMLCh * | getFullName () const=0
| Get the full name of this attribute type.
virtual void | reset ()=0
| The derived class should implement any cleaning up required between each use of an instance of this class for validation.
Getter methods
DefAttTypes | getDefaultType () const
| Get the default type of this attribute type.
const XMLCh * | getEnumeration () const
| Get the enumeration value (if any) of this attribute type.
unsigned int | getId () const
| Get the pool id of this attribute type.
bool | getProvided () const
| Query whether the attribute was explicitly provided.
AttTypes | getType () const
| Get the type of this attribute.
const XMLCh * | getValue () const
| Get the default/fixed value of this attribute (if any.).
CreateReasons | getCreateReason () const
| Get the create reason for this attribute.
bool | isExternal () const
| Indicate whether this attribute has been declared externally.
MemoryManager * | getMemoryManager () const
| Get the plugged-in memory manager.
virtual const XMLCh * | getDOMTypeInfoUri () const=0
virtual const XMLCh * | getDOMTypeInfoName () const=0
Setter methods
void | setDefaultType (const XMLAttDef::DefAttTypes newValue)
| Set the default attribute type.
void | setId (const unsigned int newId)
| Set the pool id for this attribute type.
void | setProvided (const bool newValue)
| Set or clear the 'provided' flag.
void | setType (const XMLAttDef::AttTypes newValue)
| Set the type of this attribute type.
void | setValue (const XMLCh *const newValue)
| Set the default/fixed value of this attribute type.
void | setEnumeration (const XMLCh *const newValue)
| Set the enumerated value of this attribute type.
void | setCreateReason (const CreateReasons newReason)
| Update the create reason for this attribute type.
void | setExternalAttDeclaration (const bool aValue)
| Set the attribute decl to indicate external declaration.

## Static Public Methods

Public, static methods
const XMLCh * | getAttTypeString (const AttTypes attrType)
| Get a string representation of the passed attribute type enum.
const XMLCh * | getDefAttTypeString (const DefAttTypes attrType)
| Get a string representation of the passed def attribute type enum.

## Static Public Attributes

const unsigned int | fgInvalidAttrId

## Protected Methods

| XMLAttDef (const AttTypes type=CData, const DefAttTypes defType=Implied, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
| XMLAttDef (const XMLCh *const attValue, const AttTypes type, const DefAttTypes defType, const XMLCh *const enumValues=0, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)

## Detailed Description

Represents the core information of an atribute definition.

This class defines the basic characteristics of an attribute, no matter what type of validator is used. If a particular schema associates more information with an attribute it will create a derivative of this class. So this class provides an abstract way to get basic information on attributes from any type of validator.

This class supports keyed collection semantics on the fully qualified attribute name, by providing a getKey() method to extract the key string. getKey(), in this case, just calls the virtual method getFullName() to get the fully qualified name, as defined by the derived class.

Note that the 'value' of an attribute type definition is the default or of fixed value given to it in its definition. If the attribute is of the enumerated or notation type, it will have an 'enumeration value' as well which is a space separated list of its possible vlaues.

## Member Enumeration Documentation

enum XMLAttDef::AttTypes

Enumeration values:

  CData |
  ID |
  IDRef |
  IDRefs |
  Entity |
  Entities |
  NmToken |
  NmTokens |
  Notation |
  Enumeration |
  Simple |
  Any_Any |
  Any_Other |
  Any_List |
  AttTypes_Count |
  AttTypes_Min |
  AttTypes_Max |
  AttTypes_Unknown |

enum XMLAttDef::CreateReasons

Enumeration values:

  NoReason |
  JustFaultIn |

enum XMLAttDef::DefAttTypes

Enumeration values:

  Default |
  Fixed |
  Required |
  Required_And_Fixed |
  Implied |
  ProcessContents_Skip |
  ProcessContents_Lax |
  ProcessContents_Strict |
  Prohibited |
  DefAttTypes_Count |
  DefAttTypes_Min |
  DefAttTypes_Max |
  DefAttTypes_Unknown |

## Constructor & Destructor Documentation

virtual XMLAttDef::~XMLAttDef | ( |  | ) | `[virtual]`

| Destructor.

XMLAttDef::XMLAttDef | ( | const AttTypes | type = CData,
|  | const DefAttTypes | defType = Implied,
|  | MemoryManager *const | manager = XMLPlatformUtils::fgMemoryManager
| ) | `[protected]`

XMLAttDef::XMLAttDef | ( | const XMLCh *const | attValue,
|  | const AttTypes | type,
|  | const DefAttTypes | defType,
|  | const XMLCh *const | enumValues = 0,
|  | MemoryManager *const | manager = XMLPlatformUtils::fgMemoryManager
| ) | `[protected]`

## Member Function Documentation

const XMLCh* XMLAttDef::getAttTypeString | ( | const AttTypes | attrType | ) | `[static]`

Get a string representation of the passed attribute type enum.

This method allows you to get a textual representation of an attriubte type, mostly for debug or display.

Parameters:

  attrType | The attribute type value to get the string for.

Returns:
  A const pointer to the static string that holds the text description of the passed type.

XMLAttDef::CreateReasons XMLAttDef::getCreateReason | ( |  | ) |

Get the create reason for this attribute.

This method returns an enumeration which indicates why this attribute declaration exists.

Returns:
  An enumerated value that indicates the reason why this attribute was added to the attribute table.

const XMLCh* XMLAttDef::getDefAttTypeString | ( | const DefAttTypes | attrType | ) | `[static]`

Get a string representation of the passed def attribute type enum.

This method allows you to get a textual representation of an default attributetype, mostly for debug or display.

Parameters:

  attrType | The default attribute type value to get the string for.

Returns:
  A const pointer to the static string that holds the text description of the passed default type.

XMLAttDef::DefAttTypes XMLAttDef::getDefaultType | ( |  | ) |

Get the default type of this attribute type.

This method returns the 'default type' of the attribute. Default type in this case refers to the XML concept of a default type for an attribute, i.e. FIXED, IMPLIED, etc...

Returns:
  The default type enum for this attribute type.

virtual const XMLCh* XMLAttDef::getDOMTypeInfoName | ( |  | ) | `[pure virtual]`

Returns:
  the name part of DOM Level 3 TypeInfo

virtual const XMLCh* XMLAttDef::getDOMTypeInfoUri | ( |  | ) | `[pure virtual]`

Returns:
  the uri part of DOM Level 3 TypeInfo

const XMLCh * XMLAttDef::getEnumeration | ( |  | ) |

Get the enumeration value (if any) of this attribute type.

If the attribute is of an enumeration or notatin type, then this method will return a const reference to a string that contains the space separated values that can the attribute can have.

Returns:
  A const pointer to a string that contains the space separated legal values for this attribute.

virtual const XMLCh* XMLAttDef::getFullName | ( |  | ) | `[pure virtual]`

Get the full name of this attribute type.

The derived class should return a const pointer to the full name of this attribute. This will vary depending on the type of validator in use.

Returns:
  A const pointer to the full name of this attribute type.

unsigned int XMLAttDef::getId | ( |  | ) |

Get the pool id of this attribute type.

This method will return the id of this attribute in the validator's attribute pool. It was set by the validator when this attribute was created.

Returns:
  The pool id of this attribute type.

MemoryManager * XMLAttDef::getMemoryManager | ( |  | ) |

Get the plugged-in memory manager.

This method returns the plugged-in memory manager user for dynamic memory allocation/deallocation.

Returns:
  the plugged-in memory manager

bool XMLAttDef::getProvided | ( |  | ) |

Query whether the attribute was explicitly provided.

When the scanner scans a start tag, it will ask the element decl object of the element type of that start tag to clear the 'provided' flag on all its attributes. As the scanner sees explicitly provided attributes, its turns on this flag to indicate that this attribute has been provided. In this way, the scanner can catch duplicated attributes and required attributes that aren't provided, and default in fixed/default valued attributes that are not explicitly provided.

Returns:
  Returns a boolean value that indicates whether this attribute was explicitly provided.

XMLAttDef::AttTypes XMLAttDef::getType | ( |  | ) |

Get the type of this attribute.

Gets the type of this attribute. This type is represented by an enum that convers the types of attributes allowed by XML, e.g. CDATA, NMTOKEN, NOTATION, etc...

Returns:
  The attribute type enumeration value for this type of attribute.

const XMLCh * XMLAttDef::getValue | ( |  | ) |

Get the default/fixed value of this attribute (if any.).

If the attribute defined a default/fixed value, then it is stored and this method will retrieve it. If it has non, then a null pointer is returned.

Returns:
  A const pointer to the default/fixed value for this attribute type.

bool XMLAttDef::isExternal | ( |  | ) |

Indicate whether this attribute has been declared externally.

This method returns a boolean that indicates whether this attribute has been declared externally.

Returns:
  true if this attribute has been declared externally, else false.

virtual void XMLAttDef::reset | ( |  | ) | `[pure virtual]`

| The derived class should implement any cleaning up required between each use of an instance of this class for validation.

void XMLAttDef::setCreateReason | ( | const CreateReasons | newReason | ) |

Update the create reason for this attribute type.

This method will update the 'create reason' field for this attribute decl object.

Parameters:

  newReason | The new create reason.

void XMLAttDef::setDefaultType | ( | const XMLAttDef::DefAttTypes | newValue | ) |

Set the default attribute type.

This method sets the default attribute type for this attribute. This setting controls whether the attribute is required, fixed, implied, etc...

Parameters:

  newValue | The new default attribute to set

void XMLAttDef::setEnumeration | ( | const XMLCh *const | newValue | ) |

Set the enumerated value of this attribute type.

This method sets the enumerated/notation value list for this attribute type. It is a space separated set of possible values. These values must meet the constrains of the XML spec for such values of this type of attribute. This should only be set if the setType() method is used to set the type to the enumeration or notation types.

Parameters:

  newValue | The new enumerated/notation value list to set.

void XMLAttDef::setExternalAttDeclaration | ( | const bool | aValue | ) |

Set the attribute decl to indicate external declaration.

Parameters:

  aValue | The new value to indicate external declaration.

void XMLAttDef::setId | ( | const unsigned int | newId | ) |

Set the pool id for this attribute type.

This method sets the pool id of this attribute type. This is usually called by the validator that creates the actual instance (which is of a derived type known only by the validator.)

Parameters:

  newId | The new pool id to set.

void XMLAttDef::setProvided | ( | const bool | newValue | ) |

Set or clear the 'provided' flag.

This method will set or clear the 'provided' flag. This is called by the scanner as it is scanning a start tag and marking off the attributes that have been explicitly provided.

Parameters:

  newValue | The new provided state to set

void XMLAttDef::setType | ( | const XMLAttDef::AttTypes | newValue | ) |

Set the type of this attribute type.

This method will set the type of the attribute. The type of an attribute controls how it is normalized and what kinds of characters it can hold.

Parameters:

  newValue | The new attribute type to set

void XMLAttDef::setValue | ( | const XMLCh *const | newValue | ) |

Set the default/fixed value of this attribute type.

This method set the fixed/default value for the attribute. This value will be used when instances of this attribute type are faulted in. It must be a valid value for the type set by setType(). If the type is enumeration or notation, this must be one of the valid values set in the setEnumeration() call.

Parameters:

  newValue | The new fixed/default value to set.

## Member Data Documentation

const unsigned int XMLAttDef::fgInvalidAttrId`[static]`

The documentation for this class was generated from the following file:

- XMLAttDef.hpp

Copyright © 2000 The Apache Software Foundation. All Rights Reserved.