001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 1999 The Apache Software Foundation. All rights
006: * reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package org.apache.xerces.validators.common;
059:
060: import org.apache.xerces.utils.QName;
061:
062: /**
063: * ---------------------------------------------------------------------------
064: * InsertableElementsInfo is a simple 'data packet' class that is used to
065: * get information into and out of the validator APIs that allow you to ask
066: * what kind of elements can be inserted into a particular place in an
067: * element's content model.
068: *
069: * The parent element is not explicitly stored here, since it is a separate
070: * parameter to the methods that do the query.
071: *
072: * Since it exists purely to exchange data, it just uses simple public
073: * data members.
074: * ---------------------------------------------------------------------------
075: * InsertableElementsInfo is a simple 'data packet' class that is used to
076: * get information into and out of the validator APIs that allow you to ask
077: * what kind of elements can be inserted into a particular place in an
078: * element's content model.
079: * <p>
080: * The parent element is not explicitly stored here, since it is a separate
081: * parameter to the methods that do the query.
082: * <p>
083: * Since it exists purely to exchange data, it just uses simple public
084: * data members.
085: *
086: * @version $Id: InsertableElementsInfo.java,v 1.2 2000/05/17 18:33:04 jeffreyr Exp $
087: */
088: public class InsertableElementsInfo {
089: /**
090: * One of the things that could be inserted here is a PCDATA node,
091: * in addition to the element type nodes reported.
092: */
093: public boolean canHoldPCData;
094:
095: /**
096: * The count of elements in the curChildren array. The array can be
097: * larger than this (for reuse purposes), so this value indicates
098: * how many elements are valid.
099: * <p>
100: * Note that, since the curChildren array must have an empty slot at
101: * the insertion index, this value can never be zero.
102: * <p>
103: * Note also that this value can be changed during processing, though
104: * its value on return is meaningless to the caller.
105: */
106: public int childCount;
107:
108: /**
109: * The current list of children of the parent element. This may or
110: * may not be the <em>real</em> list of children, since the caller can lie
111: * but that's of no concern to the validator. These query APIs are
112: * intended to be for 'what if' kind of work, so any list of children
113: * could be passed in.
114: * <p>
115: * There must be an empy slot in the array at the requested insertion
116: * point. That slot does not have to have any particular value, but
117: * it will be used by the validator to do brute force validation in
118: * some cases when a 'fully valid' check is done for valid insertable
119: * elements.
120: * <p>
121: * Note that this array can be modified by the call, so do not expect
122: * its contents to remain the same as on input.
123: */
124: public QName curChildren[];
125:
126: /**
127: * Indicates that one of the valid things after the insert point is
128: * 'end of content', which means that the element being inserted
129: * after can legally be the last element.
130: */
131: public boolean isValidEOC;
132:
133: /**
134: * The insertion point. The question is 'what can go here' and this
135: * indicates where 'where' is. It is an offset into curChildren.
136: */
137: public int insertAt;
138:
139: /**
140: * This array is filled with flags that indicate what the possible
141: * insertable elements are (i.e. the list of unique elements that
142: * could possibly be inserted somewhere in this type of element.)
143: * Effectively this is the list of unique children in the content
144: * model of the parent element.
145: * <p>
146: * If this array is not big enough to hold the results, or is null,
147: * then it will be replaced with a new array of the correct size.
148: */
149: public QName possibleChildren[];
150:
151: /**
152: * The number of elements that are valid in the possibleChildren
153: * and resultsCount arrays. They can be larger than that, so there
154: * must be a way to indicate how many elements are filled in with
155: * value results. If they were not at least this large on input,
156: * then they will be reallocated up to this size.
157: */
158: public int resultsCount;
159:
160: /**
161: * This array must be at least as large as possibleChildren since
162: * a flag is set in the same indexes in this array to indicate that
163: * the possible child at that index in possibleChildren can be
164: * inserted at the requested insertion point.
165: * <p>
166: * If this array is not big enough to hold the results, or is null,
167: * then it will be replaced with a new array of the correct size.
168: */
169: public boolean results[];
170:
171: } // class InsertableElementsInfo
|