TypeInfoProvider

AI-generated Key Takeaways

• TypeInfoProvider gives access to type information determined by ValidatorHandler, useful for schema languages like W3C XML Schema.

• This class allows retrieval of type information for attributes and elements within XML documents during validation.

• It helps identify ID attributes and distinguish between original and validator-added attributes.

• Implementations are obtained through ValidatorHandler.getTypeInfoProvider().

public abstract class TypeInfoProvider extends Object

This class provides access to the type information determined by ValidatorHandler.

Some schema languages, such as W3C XML Schema, encourages a validator to report the "type" it assigns to each attribute/element. Those applications who wish to access this type information can invoke methods defined on this "interface" to access such type information.

Implementation of this "interface" can be obtained through the ValidatorHandler.getTypeInfoProvider() method.

See Also

• TypeInfo

Protected Constructor Summary

TypeInfoProvider() Constructor for the derived class.

Public Method Summary

abstract TypeInfo	getAttributeTypeInfo(int index) Returns the immutable TypeInfo object for the specified attribute of the current element.
abstract TypeInfo	getElementTypeInfo() Returns the immutable TypeInfo object for the current element.
abstract boolean	isIdAttribute(int index) Returns true if the specified attribute is determined to be ID.
abstract boolean	isSpecified(int index) Returns false if the attribute was added by the validator.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Protected Constructors

protected TypeInfoProvider ()

Constructor for the derived class.

The constructor does nothing.

Public Methods

public abstract TypeInfo getAttributeTypeInfo (int index)

Returns the immutable TypeInfo object for the specified attribute of the current element.

The method may only be called by the startElement event of the ContentHandler that the application sets to the ValidatorHandler.

Parameters

index	The index of the attribute. The same index for the Attributes object passed to the startElement callback.

Returns

• An immutable TypeInfo object that represents the type of the specified attribute. Note that the caller can keep references to the obtained TypeInfo longer than the callback scope. Otherwise, this method returns null if the validator is unable to determine the type.

Throws

IndexOutOfBoundsException	If the index is invalid.
IllegalStateException	If this method is called from other ContentHandler methods.

public abstract TypeInfo getElementTypeInfo ()

Returns the immutable TypeInfo object for the current element.

The method may only be called by the startElement and endElement event of the ContentHandler that the application sets to the ValidatorHandler.

Returns

• An immutable TypeInfo object that represents the type of the current element. Note that the caller can keep references to the obtained TypeInfo longer than the callback scope. Otherwise, this method returns null if the validator is unable to determine the type of the current element for some reason (for example, if the validator is recovering from an earlier error.)

Throws

IllegalStateException	If this method is called from other ContentHandler methods.

public abstract boolean isIdAttribute (int index)

Returns true if the specified attribute is determined to be ID.

Exactly how an attribute is "determined to be ID" is up to the schema language. In case of W3C XML Schema, this means that the actual type of the attribute is the built-in ID type or its derived type.

A DocumentBuilder uses this information to properly implement Attr.isId().

The method may only be called by the startElement event of the ContentHandler that the application sets to the ValidatorHandler.

Parameters

index	The index of the attribute. The same index for the Attributes object passed to the startElement callback.

Returns

• true if the type of the specified attribute is ID.

Throws

IndexOutOfBoundsException	If the index is invalid.
IllegalStateException	If this method is called from other ContentHandler methods.

public abstract boolean isSpecified (int index)

Returns false if the attribute was added by the validator.

This method provides information necessary for a DocumentBuilder to determine what the DOM tree should return from the Attr.getSpecified() method.

The method may only be called by the startElement event of the ContentHandler that the application sets to the ValidatorHandler.

A general guideline for validators is to return true if the attribute was originally present in the pipeline, and false if it was added by the validator.

Parameters

index	The index of the attribute. The same index for the Attributes object passed to the startElement callback.

Returns

• true if the attribute was present before the validator processes input. false if the attribute was added by the validator.

Throws

IndexOutOfBoundsException	If the index is invalid.
IllegalStateException	If this method is called from other ContentHandler methods.