KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > impl > xs > models > XSEmptyCM


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 2001, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package com.sun.org.apache.xerces.internal.impl.xs.models;
59
60 import com.sun.org.apache.xerces.internal.xni.QName;
61 import com.sun.org.apache.xerces.internal.impl.xs.SubstitutionGroupHandler;
62 import com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaException;
63
64 import java.util.Vector JavaDoc;
65
66 /**
67  * XSEmptyCM is a derivative of the abstract content model base class that
68  * handles a content model with no chilren (elements).
69  *
70  * This model validated on the way in.
71  *
72  * @author Elena Litani, Lisa Martin
73  * @author IBM
74  * @version $Id: XSEmptyCM.java,v 1.6 2003/03/11 15:48:33 sandygao Exp $
75  */
76 public class XSEmptyCM implements XSCMValidator {
77
78     //
79 // Constants
80 //
81
82     // start the content model: did not see any children
83 private static final short STATE_START = 0;
84     
85     private static final Vector JavaDoc EMPTY = new Vector JavaDoc(0);
86
87     //
88 // Data
89 //
90
91     //
92 // XSCMValidator methods
93 //
94
95     /**
96      * This methods to be called on entering a first element whose type
97      * has this content model. It will return the initial state of the content model
98      *
99      * @return Start state of the content model
100      */
101     public int[] startContentModel(){
102         return (new int[] {STATE_START});
103     }
104
105
106     /**
107      * The method corresponds to one transaction in the content model.
108      *
109      * @param elementName
110      * @param state Current state
111      * @return element index corresponding to the element from the Schema grammar
112      */
113     public Object JavaDoc oneTransition (QName elementName, int[] currentState, SubstitutionGroupHandler subGroupHandler){
114
115         // error state
116 if (currentState[0] < 0) {
117             currentState[0] = XSCMValidator.SUBSEQUENT_ERROR;
118             return null;
119         }
120
121         currentState[0] = XSCMValidator.FIRST_ERROR;
122         return null;
123     }
124
125
126     /**
127      * The method indicates the end of list of children
128      *
129      * @param state Current state of the content model
130      * @return true if the last state was a valid final state
131      */
132     public boolean endContentModel (int[] currentState){
133         boolean isFinal = false;
134         int state = currentState[0];
135
136         // restore content model state:
137
138         // error
139 if (state < 0) {
140             return false;
141         }
142
143
144         return true;
145     }
146
147     /**
148      * check whether this content violates UPA constraint.
149      *
150      * @param errors to hold the UPA errors
151      * @return true if this content model contains other or list wildcard
152      */
153     public boolean checkUniqueParticleAttribution(SubstitutionGroupHandler subGroupHandler) throws XMLSchemaException {
154         return false;
155     }
156
157     /**
158      * Check which elements are valid to appear at this point. This method also
159      * works if the state is in error, in which case it returns what should
160      * have been seen.
161      *
162      * @param state the current state
163      * @return a Vector whose entries are instances of
164      * either XSWildcardDecl or XSElementDecl.
165      */
166     public Vector JavaDoc whatCanGoHere(int[] state) {
167         return EMPTY;
168     }
169     
170 } // class XSEmptyCM
171
Popular Tags