Class ValidatorPair
- java.lang.Object
-
- org.codehaus.stax2.validation.XMLValidator
-
- org.codehaus.stax2.validation.ValidatorPair
-
public class ValidatorPair extends XMLValidator
Simple utility class that allows chaining ofXMLValidator
instances. Since the class itself implementsXMLValidator
, 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
Fields Modifier and Type Field Description static 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, CONTENT_ALLOW_WS_NONSTRICT
-
-
Constructor Summary
Constructors Constructor Description ValidatorPair(XMLValidator first, XMLValidator second)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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)
String
validateAttribute(String localName, String uri, 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.).String
validateAttribute(String localName, String uri, String prefix, 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 callingXMLValidator.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(String localName, String uri, String prefix)
Method called right after encountering an element close tag.void
validateElementStart(String localName, String uri, String prefix)
void
validateText(char[] cbuf, int textStart, int textEnd, boolean lastTextSegment)
Method called to validate textual content.void
validateText(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
-
-
-
-
Field Detail
-
ATTR_TYPE_DEFAULT
public static final String ATTR_TYPE_DEFAULT
- See Also:
- Constant Field Values
-
mFirst
protected XMLValidator mFirst
-
mSecond
protected XMLValidator mSecond
-
-
Constructor Detail
-
ValidatorPair
public ValidatorPair(XMLValidator first, XMLValidator second)
-
-
Method Detail
-
getSchema
public XMLValidationSchema getSchema()
Two choices here; could either return schema of the first child, or return null. Let's do latter, do avoid accidental matches.- Specified by:
getSchema
in classXMLValidator
-
validateElementStart
public void validateElementStart(String localName, String uri, String prefix) throws XMLStreamException
- Specified by:
validateElementStart
in classXMLValidator
- Throws:
XMLStreamException
-
validateAttribute
public String validateAttribute(String localName, String uri, String prefix, String value) throws XMLStreamException
Description copied from class:XMLValidator
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.).- Specified by:
validateAttribute
in classXMLValidator
- Returns:
- Null, if the passed value is fine as is; or a String, if it needs to be replaced. In latter case, caller will replace the value before passing it to other validators. Also, if the attribute value is accessible via caller (as is the case for stream readers), caller should return this value, instead of the original one.
- Throws:
XMLStreamException
-
validateAttribute
public String validateAttribute(String localName, String uri, String prefix, char[] valueChars, int valueStart, int valueEnd) throws XMLStreamException
Description copied from class:XMLValidator
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.).- Specified by:
validateAttribute
in classXMLValidator
valueChars
- Character array that contains value (possibly along with some other text)valueStart
- Index of the first character of the value in invalueChars
arrayvalueEnd
- Index of the character AFTER the last character; so that the length of the value String isvalueEnd - valueStart
- Returns:
- Null, if the passed value is fine as is; or a String, if it needs to be replaced. In latter case, caller will replace the value before passing it to other validators. Also, if the attribute value is accessible via caller (as is the case for stream readers), caller should return this value, instead of the original one.
- Throws:
XMLStreamException
-
validateElementAndAttributes
public int validateElementAndAttributes() throws XMLStreamException
Description copied from class:XMLValidator
Method called after callingXMLValidator.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.- Specified by:
validateElementAndAttributes
in classXMLValidator
- Returns:
- One of
CONTENT_ALLOW_
constants, to indicate what kind of textual content is allowed at the scope returned to after the element has closed. - Throws:
XMLStreamException
-
validateElementEnd
public int validateElementEnd(String localName, String uri, String prefix) throws XMLStreamException
Description copied from class:XMLValidator
Method called right after encountering an element close tag.- Specified by:
validateElementEnd
in classXMLValidator
- Returns:
- One of
CONTENT_ALLOW_
constants, to indicate what kind of textual content is allowed at the scope returned to after the element has closed. - Throws:
XMLStreamException
-
validateText
public void validateText(String text, boolean lastTextSegment) throws XMLStreamException
Description copied from class:XMLValidator
Method called to validate textual content.Note: this method is only guaranteed to be called when
XMLValidator.validateElementAndAttributes()
for the currently open element returnedXMLValidator.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.- Specified by:
validateText
in classXMLValidator
- Parameters:
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.- Throws:
XMLStreamException
-
validateText
public void validateText(char[] cbuf, int textStart, int textEnd, boolean lastTextSegment) throws XMLStreamException
Description copied from class:XMLValidator
Method called to validate textual content.Note: this method is only guaranteed to be called when
XMLValidator.validateElementAndAttributes()
for the currently open element returnedXMLValidator.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.- Specified by:
validateText
in classXMLValidator
- Parameters:
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 istextEnd - 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.- Throws:
XMLStreamException
-
validationCompleted
public void validationCompleted(boolean eod) throws XMLStreamException
Description copied from class:XMLValidator
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).- Specified by:
validationCompleted
in classXMLValidator
- Parameters:
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).- Throws:
XMLStreamException
-
getAttributeType
public String getAttributeType(int index)
Description copied from class:XMLValidator
Method for getting schema-specified type of an attribute, if information is available. If not, validators can return null to explicitly indicate no information was available.- Specified by:
getAttributeType
in classXMLValidator
-
getIdAttrIndex
public int getIdAttrIndex()
Description copied from class:XMLValidator
Method for finding out the index of the attribute that is of type ID; derived from DTD, W4C Schema, or some other validation source. Usually schemas explicitly specifies that at most one attribute can have this type for any element.- Specified by:
getIdAttrIndex
in classXMLValidator
- Returns:
- Index of the attribute with type ID, in the current element, if one exists: -1 otherwise
-
getNotationAttrIndex
public int getNotationAttrIndex()
Description copied from class:XMLValidator
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. DTD explicitly specifies that at most one attribute can have this type for any element.- Specified by:
getNotationAttrIndex
in classXMLValidator
- Returns:
- Index of the attribute with type NOTATION, in the current element, if one exists: -1 otherwise
-
removeValidator
public static boolean removeValidator(XMLValidator root, XMLValidationSchema schema, XMLValidator[] results)
-
removeValidator
public static boolean removeValidator(XMLValidator root, XMLValidator vld, XMLValidator[] results)
-
-