KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > xs > XSAttributeDeclaration


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 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) 2003, 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.xs;
59
60 /**
61  * The interface represents the Attribute Declaration schema component.
62  */
63 public interface XSAttributeDeclaration extends XSObject {
64     /**
65      * [type definition]: A simple type definition.
66      */
67     public XSSimpleTypeDefinition getTypeDefinition();
68
69     /**
70      * [scope]. One of <code>SCOPE_GLOBAL</code>, <code>SCOPE_LOCAL</code>, or
71      * <code>SCOPE_ABSENT</code>. If the scope is local, then the
72      * <code>enclosingCTDefinition</code> is present.
73      */
74     public short getScope();
75
76     /**
77      * The complex type definition for locally scoped declarations (see
78      * <code>scope</code>), otherwise <code>null</code> if no such
79      * definition exists.
80      */
81     public XSComplexTypeDefinition getEnclosingCTDefinition();
82
83     /**
84      * Value constraint: one of <code>VC_NONE, VC_DEFAULT, VC_FIXED</code>.
85      */
86     public short getConstraintType();
87
88     /**
89      * Value constraint: The constraint value with respect to the [type
90      * definition], otherwise <code>null</code>.
91      */
92     public String JavaDoc getConstraintValue();
93
94     /**
95      * Value Constraint: Binding specific actual constraint value or
96      * <code>null</code> if the value is in error or there is no value
97      * constraint.
98      * @exception XSException
99      * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
100      * method.
101      */
102     public Object JavaDoc getActualVC()
103                                                         throws XSException;
104
105     /**
106      * The actual constraint value built-in datatype, e.g.
107      * <code>STRING_DT, SHORT_DT</code>. If the type definition of this
108      * value is a list type definition, this method returns
109      * <code>LIST_DT</code>. If the type definition of this value is a list
110      * type definition whose item type is a union type definition, this
111      * method returns <code>LISTOFUNION_DT</code>. To query the actual
112      * constraint value of the list or list of union type definitions use
113      * <code>itemValueTypes</code>. If the <code>actualValue</code> is
114      * <code>null</code>, this method returns <code>UNAVAILABLE_DT</code>.
115      * @exception XSException
116      * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
117      * method.
118      */
119     public short getActualVCType()
120                                                         throws XSException;
121
122     /**
123      * In the case the actual constraint value represents a list, i.e. the
124      * <code>actualValueType</code> is <code>LIST_DT</code>, the returned
125      * array consists of one type kind which represents the itemType. If the
126      * actual constraint value represents a list type definition whose item
127      * type is a union type definition, i.e. <code>LISTOFUNION_DT</code>,
128      * for each actual constraint value in the list the array contains the
129      * corresponding memberType kind. For examples, see
130      * <code>ItemPSVI.itemValueTypes</code>.
131      * @exception XSException
132      * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
133      * method.
134      */
135     public ShortList getItemValueTypes()
136                                                         throws XSException;
137
138     /**
139      * An annotation if it exists, otherwise <code>null</code>.
140      */
141     public XSAnnotation getAnnotation();
142
143 }
144
Popular Tags