1 /*
2 * reserved comment block
3 * DO NOT REMOVE OR ALTER!
4 */
5 /*
6 * Licensed to the Apache Software Foundation (ASF) under one or more
7 * contributor license agreements. See the NOTICE file distributed with
8 * this work for additional information regarding copyright ownership.
9 * The ASF licenses this file to You under the Apache License, Version 2.0
10 * (the "License"); you may not use this file except in compliance with
11 * the License. You may obtain a copy of the License at
12 *
13 * http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 */
21
22 package com.sun.org.apache.xerces.internal.xs;
23
99 * <code>[schema error code]</code>: a list of error codes generated from
100 * the validation attempt or an empty <code>StringList</code> if no
101 * errors occurred during the validation attempt.
102 */
103 public StringList getErrorCodes();
104
105 /**
106 * A list of error messages generated from the validation attempt or
107 * an empty <code>StringList</code> if no errors occurred during the
108 * validation attempt. The indices of error messages in this list are
109 * aligned with those in the <code>[schema error code]</code> list.
110 */
111 public StringList getErrorMessages();
112
113 /**
114 * <code>[schema normalized value]</code>: the normalized value of this
115 * item after validation.
116 *
117 * @deprecated Use getSchemaValue().getNormalizedValue() instead
118 */
119 public String getSchemaNormalizedValue();
120
121 /**
122 * <code>[schema normalized value]</code>: Binding specific actual value
123 * or <code>null</code> if the value is in error.
124 * @exception XSException
125 * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
126 * method.
127 *
128 * @deprecated Use getSchemaValue().getActualValue() instead
129 */
130 public Object getActualNormalizedValue()
131 throws XSException;
132
133 /**
134 * The actual value built-in datatype, e.g.
135 * <code>STRING_DT, SHORT_DT</code>. If the type definition of this
136 * value is a list type definition, this method returns
137 * <code>LIST_DT</code>. If the type definition of this value is a list
138 * type definition whose item type is a union type definition, this
139 * method returns <code>LISTOFUNION_DT</code>. To query the actual value
140 * of the list or list of union type definitions use
141 * <code>itemValueTypes</code>. If the <code>actualNormalizedValue</code>
142 * is <code>null</code>, this method returns <code>UNAVAILABLE_DT</code>.
143 * @exception XSException
144 * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
145 * method.
146 *
147 * @deprecated Use getSchemaValue().getActualValueType() instead
148 */
149 public short getActualNormalizedValueType()
150 throws XSException;
151
152 /**
153 * In the case the actual value represents a list, i.e. the
154 * <code>actualNormalizedValueType</code> is <code>LIST_DT</code>, the
155 * returned array consists of one type kind which represents the itemType
156 * . For example:
157 * <pre> <simpleType name="listtype"> <list
158 * itemType="positiveInteger"/> </simpleType> <element
159 * name="list" type="listtype"/> ... <list>1 2 3</list> </pre>
160 *
161 * The <code>schemaNormalizedValue</code> value is "1 2 3", the
162 * <code>actualNormalizedValueType</code> value is <code>LIST_DT</code>,
163 * and the <code>itemValueTypes</code> is an array of size 1 with the
164 * value <code>POSITIVEINTEGER_DT</code>.
165 * <br> If the actual value represents a list type definition whose item
166 * type is a union type definition, i.e. <code>LISTOFUNION_DT</code>,
167 * for each actual value in the list the array contains the
168 * corresponding memberType kind. For example:
169 * <pre> <simpleType
170 * name='union_type' memberTypes="integer string"/> <simpleType
171 * name='listOfUnion'> <list itemType='union_type'/>
172 * </simpleType> <element name="list" type="listOfUnion"/>
173 * ... <list>1 2 foo</list> </pre>
174 * The
175 * <code>schemaNormalizedValue</code> value is "1 2 foo", the
176 * <code>actualNormalizedValueType</code> is <code>LISTOFUNION_DT</code>
177 * , and the <code>itemValueTypes</code> is an array of size 3 with the
178 * following values: <code>INTEGER_DT, INTEGER_DT, STRING_DT</code>.
179 * @exception XSException
180 * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
181 * method.
182 *
183 * @deprecated Use getSchemaValue().getListValueTypes() instead
184 */
185 public ShortList getItemValueTypes()
186 throws XSException;
187
188 /**
189 * If this item has a simple type definition or a complex type with simple
190 * content, then return the value with respect to the simple type. If
191 * this item doesn't have a simple-typed value, the behavior of this method
192 * is not specified.
193 */
194 public XSValue getSchemaValue();
195
196 /**
197 * <code>[type definition]</code>: an item isomorphic to the type
198 * definition used to validate the schema item.
199 */
200 public XSTypeDefinition getTypeDefinition();
201
202 /**
203 * <code>[member type definition]</code>: if and only if that type
204 * definition is a simple type definition with {variety} union, or a
|
1 /*
2 * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
3 */
4 /*
5 * Licensed to the Apache Software Foundation (ASF) under one or more
6 * contributor license agreements. See the NOTICE file distributed with
7 * this work for additional information regarding copyright ownership.
8 * The ASF licenses this file to You under the Apache License, Version 2.0
9 * (the "License"); you may not use this file except in compliance with
10 * the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 */
20
21 package com.sun.org.apache.xerces.internal.xs;
22
98 * <code>[schema error code]</code>: a list of error codes generated from
99 * the validation attempt or an empty <code>StringList</code> if no
100 * errors occurred during the validation attempt.
101 */
102 public StringList getErrorCodes();
103
104 /**
105 * A list of error messages generated from the validation attempt or
106 * an empty <code>StringList</code> if no errors occurred during the
107 * validation attempt. The indices of error messages in this list are
108 * aligned with those in the <code>[schema error code]</code> list.
109 */
110 public StringList getErrorMessages();
111
112 /**
113 * <code>[schema normalized value]</code>: the normalized value of this
114 * item after validation.
115 *
116 * @deprecated Use getSchemaValue().getNormalizedValue() instead
117 */
118 @Deprecated
119 public String getSchemaNormalizedValue();
120
121 /**
122 * <code>[schema normalized value]</code>: Binding specific actual value
123 * or <code>null</code> if the value is in error.
124 * @exception XSException
125 * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
126 * method.
127 *
128 * @deprecated Use getSchemaValue().getActualValue() instead
129 */
130 @Deprecated
131 public Object getActualNormalizedValue()
132 throws XSException;
133
134 /**
135 * The actual value built-in datatype, e.g.
136 * <code>STRING_DT, SHORT_DT</code>. If the type definition of this
137 * value is a list type definition, this method returns
138 * <code>LIST_DT</code>. If the type definition of this value is a list
139 * type definition whose item type is a union type definition, this
140 * method returns <code>LISTOFUNION_DT</code>. To query the actual value
141 * of the list or list of union type definitions use
142 * <code>itemValueTypes</code>. If the <code>actualNormalizedValue</code>
143 * is <code>null</code>, this method returns <code>UNAVAILABLE_DT</code>.
144 * @exception XSException
145 * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
146 * method.
147 *
148 * @deprecated Use getSchemaValue().getActualValueType() instead
149 */
150 @Deprecated
151 public short getActualNormalizedValueType()
152 throws XSException;
153
154 /**
155 * In the case the actual value represents a list, i.e. the
156 * <code>actualNormalizedValueType</code> is <code>LIST_DT</code>, the
157 * returned array consists of one type kind which represents the itemType
158 * . For example:
159 * <pre> <simpleType name="listtype"> <list
160 * itemType="positiveInteger"/> </simpleType> <element
161 * name="list" type="listtype"/> ... <list>1 2 3</list> </pre>
162 *
163 * The <code>schemaNormalizedValue</code> value is "1 2 3", the
164 * <code>actualNormalizedValueType</code> value is <code>LIST_DT</code>,
165 * and the <code>itemValueTypes</code> is an array of size 1 with the
166 * value <code>POSITIVEINTEGER_DT</code>.
167 * <br> If the actual value represents a list type definition whose item
168 * type is a union type definition, i.e. <code>LISTOFUNION_DT</code>,
169 * for each actual value in the list the array contains the
170 * corresponding memberType kind. For example:
171 * <pre> <simpleType
172 * name='union_type' memberTypes="integer string"/> <simpleType
173 * name='listOfUnion'> <list itemType='union_type'/>
174 * </simpleType> <element name="list" type="listOfUnion"/>
175 * ... <list>1 2 foo</list> </pre>
176 * The
177 * <code>schemaNormalizedValue</code> value is "1 2 foo", the
178 * <code>actualNormalizedValueType</code> is <code>LISTOFUNION_DT</code>
179 * , and the <code>itemValueTypes</code> is an array of size 3 with the
180 * following values: <code>INTEGER_DT, INTEGER_DT, STRING_DT</code>.
181 * @exception XSException
182 * NOT_SUPPORTED_ERR: Raised if the implementation does not support this
183 * method.
184 *
185 * @deprecated Use getSchemaValue().getListValueTypes() instead
186 */
187 @Deprecated
188 public ShortList getItemValueTypes()
189 throws XSException;
190
191 /**
192 * If this item has a simple type definition or a complex type with simple
193 * content, then return the value with respect to the simple type. If
194 * this item doesn't have a simple-typed value, the behavior of this method
195 * is not specified.
196 */
197 public XSValue getSchemaValue();
198
199 /**
200 * <code>[type definition]</code>: an item isomorphic to the type
201 * definition used to validate the schema item.
202 */
203 public XSTypeDefinition getTypeDefinition();
204
205 /**
206 * <code>[member type definition]</code>: if and only if that type
207 * definition is a simple type definition with {variety} union, or a
|