| org.apache.xerces.validators.common.XMLContentModel
All known Subclasses: org.apache.xerces.validators.common.SimpleContentModel, org.apache.xerces.validators.common.DFAContentModel, org.apache.xerces.validators.common.MixedContentModel, org.apache.xerces.validators.common.AllContentModel,
| XMLContentModel | | public interface XMLContentModel (Code) | | ContentModel is an interface that can be used by your own custom validators
to plug in various types of content models. It is used internally as well
for the same purposes.
Since there are a number of optimizations that can be used for simple or
special content models, this class provides the interface via which all of
the various content model types are managed. So the validation handler
class has a list of things derived from this class. It finds the one for
the desired element, then asks it to validate the element contents.
The validation interface from the scanner to the validation handle provides
a child count and an array of element name indices into the string pool.
So it is assumed that those same parameters will be passed to the content
model to be validated. Therefore the validateContent() method accepts
this standard view of the elements to be validated.
author:
Dean Roddey, Eric Ye
version:
$Id: XMLContentModel.java,v 1.8 2001/06/20 20:54:40 neilg Exp $ |
| setSubstitutionGroupComparator | | public void setSubstitutionGroupComparator(SubstitutionGroupComparator comparator)(Code) | | The setter method to pass in the SubstitutionGroupComparator.
Parameters:
comparator - a SubstitutionGroupComparator object. |
| validateContent | | public int validateContent(QName children, int offset, int length) throws Exception(Code) | | Check that the specified content is valid according to this
content model. This method can also be called to do 'what if'
testing of content models just to see if they would be valid.
A value of -1 in the children array indicates a PCDATA node. All other
indexes will be positive and represent child elements. The count can be
zero, since some elements have the EMPTY content model and that must be
confirmed.
Parameters:
children - The children of this element. Each integer is an index withinthe StringPool of the child element name. An indexof -1 is used to indicate an occurrence of non-whitespace characterdata.
Parameters:
offset - Offset into the array where the children starts.
Parameters:
length - The number of entries in the children array. The value -1 if fully valid, else the 0 based index of the childthat first failed. If the value returned is equal to the numberof children, then the specified children are valid but additionalcontent is required to reach a valid ending state.
exception:
Exception - Thrown on error. |
| validateContentSpecial | | public int validateContentSpecial(QName children, int offset, int length) throws Exception(Code) | | This method is different from "validateContent" in that it will try to use
the SubstitutionGroupComparator to match children against the content model.
A value of -1 in the children array indicates a PCDATA node. All other
indexes will be positive and represent child elements. The count can be
zero, since some elements have the EMPTY content model and that must be
confirmed.
Parameters:
children - The children of this element. Each integer is an index withinthe StringPool of the child element name. An indexof -1 is used to indicate an occurrence of non-whitespace characterdata.
Parameters:
offset - Offset into the array where the children starts.
Parameters:
length - The number of entries in the children array. The value -1 if fully valid, else the 0 based index of the childthat first failed. If the value returned is equal to the numberof children, then the specified children are valid but additionalcontent is required to reach a valid ending state.
exception:
Exception - Thrown on error. |
| whatCanGoHere | | public int whatCanGoHere(boolean fullyValid, InsertableElementsInfo info) throws Exception(Code) | | Returns information about which elements can be placed at a particular point
in the passed element's content model.
Note that the incoming content model to test must be valid at least up to
the insertion point. If not, then -1 will be returned and the info object
will not have been filled in.
If, on return, the info.isValidEOC flag is set, then the 'insert after'
element is a valid end of content. In other words, nothing needs to be
inserted after it to make the parent element's content model valid.
Parameters:
fullyValid - Only return elements that can be inserted and stillmaintain the validity of subsequent elements past theinsertion point (if any). If the insertion point is atthe end, and this is true, then only elements that canbe legal final states will be returned.
Parameters:
info - An object that contains the required input data for the method,and which will contain the output information if successful. The value -1 if fully valid, else the 0 based index of the childthat first failed before the insertion point. If the value returned is equal to the number of children, then the specifiedchildren are valid but additional content is required to reach avalid ending state.
See Also: InsertableElementsInfo |
|
|