• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/xsom/SCD.java@e530533619ec (annotated)

src/share/jaxws_classes/com/sun/xml/internal/xsom/SCD.java

Thu, 12 Oct 2017 19:44:07 +0800

author

aoqi

date

Thu, 12 Oct 2017 19:44:07 +0800

changeset 760

e530533619ec

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.xml.internal.xsom;
aoqi@0	27
aoqi@0	28	import com.sun.xml.internal.xsom.impl.scd.Iterators;
aoqi@0	29	import com.sun.xml.internal.xsom.impl.scd.ParseException;
aoqi@0	30	import com.sun.xml.internal.xsom.impl.scd.SCDImpl;
aoqi@0	31	import com.sun.xml.internal.xsom.impl.scd.SCDParser;
aoqi@0	32	import com.sun.xml.internal.xsom.impl.scd.Step;
aoqi@0	33	import com.sun.xml.internal.xsom.impl.scd.TokenMgrError;
aoqi@0	34	import com.sun.xml.internal.xsom.util.DeferedCollection;
aoqi@0	35
aoqi@0	36	import javax.xml.namespace.NamespaceContext;
aoqi@0	37	import java.util.Collection;
aoqi@0	38	import java.util.Iterator;
aoqi@0	39	import java.util.List;
aoqi@0	40
aoqi@0	41	/**
aoqi@0	42	* Schema Component Designator (SCD).
aoqi@0	43	*
aoqi@0	44	* <p>
aoqi@0	45	* SCD for schema is what XPath is for XML. SCD allows you to select a schema component(s)
aoqi@0	46	* from a schema component(s).
aoqi@0	47	*
aoqi@0	48	* <p>
aoqi@0	49	* See <a href="http://www.w3.org/TR/2005/WD-xmlschema-ref-20050329/">XML Schema: Component Designators</a>.
aoqi@0	50	* This implementation is based on 03/29/2005 working draft.
aoqi@0	51	*
aoqi@0	52	* @author Kohsuke Kawaguchi
aoqi@0	53	*/
aoqi@0	54	public abstract class SCD {
aoqi@0	55
aoqi@0	56	/**
aoqi@0	57	* Parses the string representation of SCD.
aoqi@0	58	*
aoqi@0	59	* <p>
aoqi@0	60	* This method involves parsing the path expression and preparing the in-memory
aoqi@0	61	* structure, so this is useful when you plan to use the same SCD against
aoqi@0	62	* different context node multiple times.
aoqi@0	63	*
aoqi@0	64	* <p>
aoqi@0	65	* If you want to evaluate SCD just once, use {@link XSComponent#select} methods.
aoqi@0	66	*
aoqi@0	67	* @param path
aoqi@0	68	* the string representation of SCD, such as "/foo/bar".
aoqi@0	69	* @param nsContext
aoqi@0	70	* Its {@link NamespaceContext#getNamespaceURI(String)} is used
aoqi@0	71	* to resolve prefixes in the SCD to the namespace URI.
aoqi@0	72	*/
aoqi@0	73	public static SCD create(String path, NamespaceContext nsContext) throws java.text.ParseException {
aoqi@0	74	try {
aoqi@0	75	SCDParser p = new SCDParser(path,nsContext);
aoqi@0	76	List<?> list = p.RelativeSchemaComponentPath();
aoqi@0	77	return new SCDImpl(path,list.toArray(new Step[list.size()]));
aoqi@0	78	} catch (TokenMgrError e) {
aoqi@0	79	throw setCause(new java.text.ParseException(e.getMessage(), -1 ),e);
aoqi@0	80	} catch (ParseException e) {
aoqi@0	81	throw setCause(new java.text.ParseException(e.getMessage(), e.currentToken.beginColumn ),e);
aoqi@0	82	}
aoqi@0	83	}
aoqi@0	84
aoqi@0	85	private static java.text.ParseException setCause(java.text.ParseException e, Throwable x) {
aoqi@0	86	e.initCause(x);
aoqi@0	87	return e;
aoqi@0	88	}
aoqi@0	89
aoqi@0	90	/**
aoqi@0	91	* Evaluates the SCD against the given context node and
aoqi@0	92	* returns the matched nodes.
aoqi@0	93	*
aoqi@0	94	* @return
aoqi@0	95	* could be empty but never be null.
aoqi@0	96	*/
aoqi@0	97	public final Collection<XSComponent> select(XSComponent contextNode) {
aoqi@0	98	return new DeferedCollection<XSComponent>(select(Iterators.singleton(contextNode)));
aoqi@0	99	}
aoqi@0	100
aoqi@0	101	/**
aoqi@0	102	* Evaluates the SCD against the whole schema and
aoqi@0	103	* returns the matched nodes.
aoqi@0	104	*
aoqi@0	105	* <p>
aoqi@0	106	* This method is here because {@link XSSchemaSet}
aoqi@0	107	* doesn't implement {@link XSComponent}.
aoqi@0	108	*
aoqi@0	109	* @return
aoqi@0	110	* could be empty but never be null.
aoqi@0	111	*/
aoqi@0	112	public final Collection<XSComponent> select(XSSchemaSet contextNode) {
aoqi@0	113	return select(contextNode.getSchemas());
aoqi@0	114	}
aoqi@0	115
aoqi@0	116	/**
aoqi@0	117	* Evaluates the SCD against the given context node and
aoqi@0	118	* returns the matched node.
aoqi@0	119	*
aoqi@0	120	* @return
aoqi@0	121	* null if the SCD didn't match anything. If the SCD matched more than one node,
aoqi@0	122	* the first one will be returned.
aoqi@0	123	*/
aoqi@0	124	public final XSComponent selectSingle(XSComponent contextNode) {
aoqi@0	125	Iterator<XSComponent> r = select(Iterators.singleton(contextNode));
aoqi@0	126	if(r.hasNext()) return r.next();
aoqi@0	127	return null;
aoqi@0	128	}
aoqi@0	129
aoqi@0	130	/**
aoqi@0	131	* Evaluates the SCD against the whole schema set and
aoqi@0	132	* returns the matched node.
aoqi@0	133	*
aoqi@0	134	* @return
aoqi@0	135	* null if the SCD didn't match anything. If the SCD matched more than one node,
aoqi@0	136	* the first one will be returned.
aoqi@0	137	*/
aoqi@0	138	public final XSComponent selectSingle(XSSchemaSet contextNode) {
aoqi@0	139	Iterator<XSComponent> r = select(contextNode.iterateSchema());
aoqi@0	140	if(r.hasNext()) return r.next();
aoqi@0	141	return null;
aoqi@0	142	}
aoqi@0	143
aoqi@0	144	/**
aoqi@0	145	* Evaluates the SCD against the given set of context nodes and
aoqi@0	146	* returns the matched nodes.
aoqi@0	147	*
aoqi@0	148	* @param contextNodes
aoqi@0	149	* {@link XSComponent}s that represent the context node against
aoqi@0	150	* which {@link SCD} is evaluated.
aoqi@0	151	*
aoqi@0	152	* @return
aoqi@0	153	* could be empty but never be null.
aoqi@0	154	*/
aoqi@0	155	public abstract Iterator<XSComponent> select(Iterator<? extends XSComponent> contextNodes);
aoqi@0	156
aoqi@0	157	/**
aoqi@0	158	* Evaluates the SCD against the given set of context nodes and
aoqi@0	159	* returns the matched nodes.
aoqi@0	160	*
aoqi@0	161	* @param contextNodes
aoqi@0	162	* {@link XSComponent}s that represent the context node against
aoqi@0	163	* which {@link SCD} is evaluated.
aoqi@0	164	*
aoqi@0	165	* @return
aoqi@0	166	* could be empty but never be null.
aoqi@0	167	*/
aoqi@0	168	public final Collection<XSComponent> select(Collection<? extends XSComponent> contextNodes) {
aoqi@0	169	return new DeferedCollection<XSComponent>(select(contextNodes.iterator()));
aoqi@0	170	}
aoqi@0	171
aoqi@0	172	/**
aoqi@0	173	* Returns the textual SCD representation as given to {@link SCD#create(String, NamespaceContext)}.
aoqi@0	174	*/
aoqi@0	175	public abstract String toString();
aoqi@0	176	}