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_Strict = 5, ProcessContents_Lax = 6, ProcessContents_Skip = 7, Prohibited = 8, DefAttTypes_Count, DefAttTypes_Min = 0, DefAttTypes_Max = 8, DefAttTypes_Unknown = -1 } |
| enum | CreateReasons { NoReason, JustFaultIn } |
Public Methods | |
Destructor | |
| virtual | ~XMLAttDef () |
Virtual interface | |
| virtual const XMLCh * | getFullName () const=0 |
Getter methods | |
| DefAttTypes | getDefaultType () const |
| const XMLCh * | getEnumeration () const |
| unsigned int | getId () const |
| bool | getProvided () const |
| AttTypes | getType () const |
| const XMLCh * | getValue () const |
| CreateReasons | getCreateReason () const |
| bool | isExternal () const |
Setter methods | |
| void | setDefaultType (const XMLAttDef::DefAttTypes newValue) |
| void | setId (const unsigned int newId) |
| void | setProvided (const bool newValue) |
| void | setType (const XMLAttDef::AttTypes newValue) |
| void | setValue (const XMLCh *const newValue) |
| void | setEnumeration (const XMLCh *const newValue) |
| void | setCreateReason (const CreateReasons newReason) |
| void | setExternalAttDeclaration (const bool aValue) |
Static Public Methods | |
Public, static methods | |
| const XMLCh * | getAttTypeString (const AttTypes attrType) |
| const XMLCh * | getDefAttTypeString (const DefAttTypes attrType) |
Static Public Attributes | |
| const unsigned int | fgInvalidAttrId = 0xFFFFFFFE |
Protected Methods | |
| XMLAttDef (const AttTypes type=CData, const DefAttTypes defType=Implied) | |
| XMLAttDef (const XMLCh *const attValue, const AttTypes type, const DefAttTypes defType, const XMLCh *const enumValues=0) | |
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.
|
|
Destructor |
|
|
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.
|
|
|
Get the create reason for this attribute This method returns an enumeration which indicates why this attribute declaration exists.
|
|
|
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.
|
|
|
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...
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
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...
|
|
|
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.
|
|
|
Indicate whether this attribute has been declared externally This method returns a boolean that indicates whether this attribute has been declared externally.
|
|
|
Update the create reason for this attribute type. This method will update the 'create reason' field for this attribute decl object.
|
|
|
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...
|
|
|
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.
|
|
|
Set the attribute decl to indicate external declaration
|
|
|
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.)
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
1.3-rc1