BEA Systems, Inc.

WebLogic Server 6.0sp2 API Reference

weblogic.apache.xerces.validators.common
Class DFAContentModel

java.lang.Object
  |
  +--weblogic.apache.xerces.validators.common.DFAContentModel

public class DFAContentModel
extends java.lang.Object
implements XMLContentModel

DFAContentModel is the derivative of ContentModel that does all of the non-trivial element content validation. This class does the conversion from the regular expression to the DFA that it then uses in its validation algorithm.

Note: Upstream work insures that this class will never see a content model with PCDATA in it. Any model with PCDATA is 'mixed' and is handled via the MixedContentModel class since mixed models are very constrained in form and easily handled via a special case. This also makes implementation of this class much easier.

This class is based on an implementation from the Apache XML Project. In future releases the XML parser, XSLT processor, and associated classes will likely be updated to be based on a later version of the Apache implementations. Since Apache does not guarantee backwards compatibility between versions of their software, we cannot guarantee backwards compatibility of any of the classes contained in the weblogic.apache package or sub-packages.

Version:
$Id: DFAContentModel.java,v 1.13 2000/08/10 02:56:32 ericye Exp $
Author:
Copyright © 2001 BEA Systems, Inc. All Rights Reserved.

Constructor Summary
DFAContentModel(CMNode syntaxTree, int leafCount)
          Constructs a DFA content model.
DFAContentModel(CMNode syntaxTree, int leafCount, boolean dtd)
          Constructs a DFA content model.
 
Method Summary
 boolean checkLastChildEndingState()
           
 ContentLeafNameTypeVector getContentLeafNameTypeVector()
           
 void setEquivClassComparator(EquivClassComparator comparator)
           
 int validateContent(QName[] children, int offset, int length)
          Check that the specified content is valid according to this content model.
 int validateContent(QName[] children, int offset, int length, boolean parentCheck, int depth)
           
 int validateContentSpecial(QName[] children, int offset, int length)
           
 int whatCanGoHere(boolean fullyValid, InsertableElementsInfo info)
          Returns information about which elements can be placed at a particular point in the passed element's content model.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DFAContentModel

public DFAContentModel(CMNode syntaxTree,
                       int leafCount)
                throws CMException
Constructs a DFA content model.

Parameters:
stringPool - The string pool.
syntaxTree - The syntax tree of the content model.
leafCount - The number of leaves.
Throws:
CMException - Thrown if DMA can't be built.

DFAContentModel

public DFAContentModel(CMNode syntaxTree,
                       int leafCount,
                       boolean dtd)
                throws CMException
Constructs a DFA content model.

Parameters:
stringPool - The string pool.
syntaxTree - The syntax tree of the content model.
leafCount - The number of leaves.
Throws:
CMException - Thrown if DMA can't be built.
Method Detail

validateContent

public int validateContent(QName[] children,
                           int offset,
                           int length)
                    throws CMException
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.

Specified by:
validateContent in interface XMLContentModel

Parameters:
children - The children of this element. Each integer is an index within the StringPool of the child element name. An index of -1 is used to indicate an occurrence of non-whitespace character data.
offset - Offset into the array where the children starts.
length - The number of entries in the children array.
Returns:
The value -1 if fully valid, else the 0 based index of the child that first failed. If the value returned is equal to the number of children, then the specified children are valid but additional content is required to reach a valid ending state.
Throws:
CMException - Thrown on error.

validateContent

public int validateContent(QName[] children,
                           int offset,
                           int length,
                           boolean parentCheck,
                           int depth)
                    throws CMException
Specified by:
validateContent in interface XMLContentModel


checkLastChildEndingState

public boolean checkLastChildEndingState()
Specified by:
checkLastChildEndingState in interface XMLContentModel


validateContentSpecial

public int validateContentSpecial(QName[] children,
                                  int offset,
                                  int length)
                           throws java.lang.Exception
Specified by:
validateContentSpecial in interface XMLContentModel


setEquivClassComparator

public void setEquivClassComparator(EquivClassComparator comparator)
Specified by:
setEquivClassComparator in interface XMLContentModel


whatCanGoHere

public int whatCanGoHere(boolean fullyValid,
                         InsertableElementsInfo info)
                  throws CMException
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.

Specified by:
whatCanGoHere in interface XMLContentModel

Parameters:
fullyValid - Only return elements that can be inserted and still maintain the validity of subsequent elements past the insertion point (if any). If the insertion point is at the end, and this is true, then only elements that can be legal final states will be returned.
info - An object that contains the required input data for the method, and which will contain the output information if successful.
Returns:
The value -1 if fully valid, else the 0 based index of the child that first failed before the insertion point. If the value returned is equal to the number of children, then the specified children are valid but additional content is required to reach a valid ending state.
See Also:
InsertableElementsInfo

getContentLeafNameTypeVector

public ContentLeafNameTypeVector getContentLeafNameTypeVector()
Specified by:
getContentLeafNameTypeVector in interface XMLContentModel


Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs60