|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.stax2.validation.XMLValidator
org.codehaus.stax2.validation.ValidatorPair
public class ValidatorPair
Simple utility class that allows chaining of XMLValidator
instances. Since the class itself implements XMLValidator
,
multiple validators can be added by chaining these pairs; ordering
of validator calls depends on ordering of the pairs.
Default semantics are quite simple: first validator of the pair is always called first, and results as/if modified by that validator are passed on to the second validator.
It is expected that this class is mostly used by actual stream reader and writer implementations; not so much by validator implementations.
Field Summary | |
---|---|
static java.lang.String |
ATTR_TYPE_DEFAULT
|
protected XMLValidator |
mFirst
|
protected XMLValidator |
mSecond
|
Fields inherited from class org.codehaus.stax2.validation.XMLValidator |
---|
CONTENT_ALLOW_ANY_TEXT, CONTENT_ALLOW_NONE, CONTENT_ALLOW_UNDEFINED, CONTENT_ALLOW_VALIDATABLE_TEXT, CONTENT_ALLOW_WS |
Constructor Summary | |
---|---|
ValidatorPair(XMLValidator first,
XMLValidator second)
|
Method Summary | |
---|---|
java.lang.String |
getAttributeType(int index)
Method for getting schema-specified type of an attribute, if information is available. |
int |
getIdAttrIndex()
Method for finding out the index of the attribute that is of type ID; derived from DTD, W4C Schema, or some other validation source. |
int |
getNotationAttrIndex()
Method for finding out the index of the attribute (collected using the attribute collector; having DTD/Schema-derived info in same order) that is of type NOTATION. |
XMLValidationSchema |
getSchema()
Two choices here; could either return schema of the first child, or return null. |
static boolean |
removeValidator(XMLValidator root,
XMLValidationSchema schema,
XMLValidator[] results)
|
static boolean |
removeValidator(XMLValidator root,
XMLValidator vld,
XMLValidator[] results)
|
java.lang.String |
validateAttribute(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix,
char[] valueChars,
int valueStart,
int valueEnd)
Callback method called on validator to give it a chance to validate the value of an attribute, as well as to normalize its value if appropriate (remove leading/trailing/intervening white space for certain token types etc.). |
java.lang.String |
validateAttribute(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix,
java.lang.String value)
Callback method called on validator to give it a chance to validate the value of an attribute, as well as to normalize its value if appropriate (remove leading/trailing/intervening white space for certain token types etc.). |
int |
validateElementAndAttributes()
Method called after calling XMLValidator.validateAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String) on all
attributes (if any), but before starting to handle element
content. |
int |
validateElementEnd(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix)
Method called right after encountering an element close tag. |
void |
validateElementStart(java.lang.String localName,
java.lang.String uri,
java.lang.String prefix)
|
void |
validateText(char[] cbuf,
int textStart,
int textEnd,
boolean lastTextSegment)
Method called to validate textual content. |
void |
validateText(java.lang.String text,
boolean lastTextSegment)
Method called to validate textual content. |
void |
validationCompleted(boolean eod)
Method called when the validation is completed; either due to the input stream ending, or due to an explicit 'stop validation' request by the application (via context object). |
Methods inherited from class org.codehaus.stax2.validation.XMLValidator |
---|
getSchemaType |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ATTR_TYPE_DEFAULT
protected XMLValidator mFirst
protected XMLValidator mSecond
Constructor Detail |
---|
public ValidatorPair(XMLValidator first, XMLValidator second)
Method Detail |
---|
public XMLValidationSchema getSchema()
getSchema
in class XMLValidator
public void validateElementStart(java.lang.String localName, java.lang.String uri, java.lang.String prefix) throws XMLValidationException
validateElementStart
in class XMLValidator
XMLValidationException
public java.lang.String validateAttribute(java.lang.String localName, java.lang.String uri, java.lang.String prefix, java.lang.String value) throws XMLValidationException
XMLValidator
validateAttribute
in class XMLValidator
XMLValidationException
public java.lang.String validateAttribute(java.lang.String localName, java.lang.String uri, java.lang.String prefix, char[] valueChars, int valueStart, int valueEnd) throws XMLValidationException
XMLValidator
validateAttribute
in class XMLValidator
valueChars
- Character array that contains value (possibly
along with some other text)valueStart
- Index of the first character of the value in
in valueChars
arrayvalueEnd
- Index of the character AFTER the last character;
so that the length of the value String is
valueEnd - valueStart
XMLValidationException
public int validateElementAndAttributes() throws XMLValidationException
XMLValidator
XMLValidator.validateAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
on all
attributes (if any), but before starting to handle element
content.
validateElementAndAttributes
in class XMLValidator
CONTENT_ALLOW_
constants, to indicate
what kind of textual content is allowed at the scope returned
to after the element has closed.
XMLValidationException
public int validateElementEnd(java.lang.String localName, java.lang.String uri, java.lang.String prefix) throws XMLValidationException
XMLValidator
validateElementEnd
in class XMLValidator
CONTENT_ALLOW_
constants, to indicate
what kind of textual content is allowed at the scope returned
to after the element has closed.
XMLValidationException
public void validateText(java.lang.String text, boolean lastTextSegment) throws XMLValidationException
XMLValidator
Note: this method is only guaranteed to be called when
XMLValidator.validateElementAndAttributes()
for the currently open
element returned XMLValidator.CONTENT_ALLOW_VALIDATABLE_TEXT
(or,
in case of mixed content, XMLValidator.validateElementEnd(java.lang.String, java.lang.String, java.lang.String)
, for the
last enclosed element). Otherwise, validator context may choose
not to call the method as an optimization.
validateText
in class XMLValidator
text
- Text content to validatelastTextSegment
- Whether this text content is the last text
segment before a close element; true if it is, false if it is not,
or no determination can be made. Can be used for optimizing
validation -- if this is true, no text needs to be buffered since
no more will be sent before the current element closes.
XMLValidationException
public void validateText(char[] cbuf, int textStart, int textEnd, boolean lastTextSegment) throws XMLValidationException
XMLValidator
Note: this method is only guaranteed to be called when
XMLValidator.validateElementAndAttributes()
for the currently open
element returned XMLValidator.CONTENT_ALLOW_VALIDATABLE_TEXT
(or,
in case of mixed content, XMLValidator.validateElementEnd(java.lang.String, java.lang.String, java.lang.String)
, for the
last enclosed element). Otherwise, validator context may choose
not to call the method as an optimization.
validateText
in class XMLValidator
cbuf
- Character array that contains text content to validatetextStart
- Index of the first character of the content to
validatetextEnd
- Character following the last character of the
content to validate (that is, length of content to validate is
textEnd - textStart
).lastTextSegment
- Whether this text content is the last text
segment before a close element; true if it is, false if it is not,
or no determination can be made. Can be used for optimizing
validation -- if this is true, no text needs to be buffered since
no more will be sent before the current element closes.
XMLValidationException
public void validationCompleted(boolean eod) throws XMLValidationException
XMLValidator
validationCompleted
in class XMLValidator
eod
- Flag that indicates whether this method was called by the
context due to the end of the stream (true); or by an application
requesting end of validation (false).
XMLValidationException
public java.lang.String getAttributeType(int index)
XMLValidator
getAttributeType
in class XMLValidator
public int getIdAttrIndex()
XMLValidator
getIdAttrIndex
in class XMLValidator
public int getNotationAttrIndex()
XMLValidator
getNotationAttrIndex
in class XMLValidator
public static boolean removeValidator(XMLValidator root, XMLValidationSchema schema, XMLValidator[] results)
public static boolean removeValidator(XMLValidator root, XMLValidator vld, XMLValidator[] results)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |