com.sun.xml.xsom.impl.scd.AbstractAxisImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xsom Show documentation
XML Schema Object Model (XSOM) is a Java library that allows applications to easily parse XML Schema documents and inspect information in them. It is expected to be useful for applications that need to take XML Schema as an input.
There is a newer version: 4.0.5
Show newest version
/*
 * Copyright (c) 1997, 2022 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

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}.
 *
 * 
 * {@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 implements Axis, XSFunction> {
    /**
     * Creates a singleton list.
     */
    protected final Iterator singleton(T t) {
        return Iterators.singleton(t);
    }

    protected final Iterator union(T[] items) {
        return new Iterators.Array<>(items);
    }

    protected final Iterator union(Iterator first, Iterator second) {
        return new Iterators.Union<>(first, second);
    }

    public Iterator 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 iterator(Iterator contextNodes) {
        return new Iterators.Map(contextNodes) {
            protected Iterator apply(XSComponent u) {
                return iterator(u);
            }
        };
    }

    public boolean isModelGroup() {
        return false;
    }

    public Iterator annotation(XSAnnotation ann) {
        return empty();
    }

    public Iterator attGroupDecl(XSAttGroupDecl decl) {
        return empty();
    }

    public Iterator attributeDecl(XSAttributeDecl decl) {
        return empty();
    }

    public Iterator attributeUse(XSAttributeUse use) {
        return empty();
    }

    public Iterator complexType(XSComplexType type) {
        // compensate particle
        XSParticle p = type.getContentType().asParticle();
        if(p!=null)
            return particle(p);
        else
            return empty();
    }

    public Iterator schema(XSSchema schema) {
        return empty();
    }

    public Iterator facet(XSFacet facet) {
        return empty();
    }

    public Iterator notation(XSNotation notation) {
        return empty();
    }

    public Iterator identityConstraint(XSIdentityConstraint decl) {
        return empty();
    }

    public Iterator xpath(XSXPath xpath) {
        return empty();
    }

    public Iterator simpleType(XSSimpleType simpleType) {
        return empty();
    }

    public Iterator particle(XSParticle particle) {
        return empty();
    }

    public Iterator empty(XSContentType empty) {
        return empty();
    }

    public Iterator wildcard(XSWildcard wc) {
        return empty();
    }

    public Iterator modelGroupDecl(XSModelGroupDecl decl) {
        return empty();
    }

    public Iterator modelGroup(XSModelGroup group) {
        // compensate for particles that are ignored in SCD
        return new Iterators.Map<>(group.iterator()) {
            protected Iterator apply(XSParticle p) {
                return particle(p);
            }
        };
    }

    public Iterator elementDecl(XSElementDecl decl) {
        return empty();
    }

    /**
     * Returns an empty list.
     */
    protected final Iterator empty() {
        return Iterators.empty();
    }

}