/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.xsom.impl.scd;
import com.sun.xml.xsom.XSAnnotation;
import com.sun.xml.xsom.XSAttGroupDecl;
import com.sun.xml.xsom.XSAttributeDecl;
import com.sun.xml.xsom.XSAttributeUse;
import com.sun.xml.xsom.XSComplexType;
import com.sun.xml.xsom.XSComponent;
import com.sun.xml.xsom.XSContentType;
import com.sun.xml.xsom.XSElementDecl;
import com.sun.xml.xsom.XSFacet;
import com.sun.xml.xsom.XSIdentityConstraint;
import com.sun.xml.xsom.XSModelGroup;
import com.sun.xml.xsom.XSModelGroupDecl;
import com.sun.xml.xsom.XSNotation;
import com.sun.xml.xsom.XSParticle;
import com.sun.xml.xsom.XSSchema;
import com.sun.xml.xsom.XSSimpleType;
import com.sun.xml.xsom.XSWildcard;
import com.sun.xml.xsom.XSXPath;
import com.sun.xml.xsom.visitor.XSFunction;
import java.util.Iterator;
/**
* Partial default implementation of {@link Axis}.
*
* <p>
* {@link XSParticle}s are skipped in SCD, so this class compensates that.
* For example, when we are considering a path from {@link XSComplexType},
* we need to also consider a path from its content type particle (if any.)
*
* @author Kohsuke Kawaguchi
*/
abstract class AbstractAxisImpl<T extends XSComponent> implements Axis<T>, XSFunction<Iterator<T>> {
/**
* Creates a singleton list.
*/
protected final Iterator<T> singleton(T t) {
return Iterators.singleton(t);
}
protected final Iterator<T> union(T... items) {
return new Iterators.Array<T>(items);
}
protected final Iterator<T> union(Iterator<? extends T> first, Iterator<? extends T> second) {
return new Iterators.Union<T>(first,second);
}
public Iterator<T> iterator(XSComponent contextNode) {
return contextNode.apply(this);
}
/**
* Gets the prefix of the axis, like "foo::".
*/
public String getName() {
return toString();
}
/**
* Default implementation that simply delegate sto {@link #iterator(XSComponent)}
*/
public Iterator<T> iterator(Iterator<? extends XSComponent> contextNodes) {
return new Iterators.Map<T,XSComponent>(contextNodes) {
protected Iterator<? extends T> apply(XSComponent u) {
return iterator(u);
}
};
}
public boolean isModelGroup() {
return false;
}
public Iterator<T> annotation(XSAnnotation ann) {
return empty();
}
public Iterator<T> attGroupDecl(XSAttGroupDecl decl) {
return empty();
}
public Iterator<T> attributeDecl(XSAttributeDecl decl) {
return empty();
}
public Iterator<T> attributeUse(XSAttributeUse use) {
return empty();
}
public Iterator<T> complexType(XSComplexType type) {
// compensate particle
XSParticle p = type.getContentType().asParticle();
if(p!=null)
return particle(p);
else
return empty();
}
public Iterator<T> schema(XSSchema schema) {
return empty();
}
public Iterator<T> facet(XSFacet facet) {
return empty();
}
public Iterator<T> notation(XSNotation notation) {
return empty();
}
public Iterator<T> identityConstraint(XSIdentityConstraint decl) {
return empty();
}
public Iterator<T> xpath(XSXPath xpath) {
return empty();
}
public Iterator<T> simpleType(XSSimpleType simpleType) {
return empty();
}
public Iterator<T> particle(XSParticle particle) {
return empty();
}
public Iterator<T> empty(XSContentType empty) {
return empty();
}
public Iterator<T> wildcard(XSWildcard wc) {
return empty();
}
public Iterator<T> modelGroupDecl(XSModelGroupDecl decl) {
return empty();
}
public Iterator<T> modelGroup(XSModelGroup group) {
// compensate for particles that are ignored in SCD
return new Iterators.Map<T,XSParticle>(group.iterator()) {
protected Iterator<? extends T> apply(XSParticle p) {
return particle(p);
}
};
}
public Iterator<T> elementDecl(XSElementDecl decl) {
return empty();
}
/**
* Returns an empty list.
*/
protected final Iterator<T> empty() {
return Iterators.empty();
}
}