All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.xsom.parser.SchemaDocument Maven / Gradle / Ivy

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.parser;

import com.sun.xml.xsom.XSSchema;

import java.util.Set;

/**
 * Represents a parsed XML schema document.
 *
 * 

* Unlike schema components defined in {@code XS****} interfaces, * which are inherently de-coupled from where it was loaded from, * {@link SchemaDocument} represents a single XML infoset that * is a schema document. * *

* This concept is often useful in tracking down the reference * relationship among schema documents. * * @see XSOMParser#getDocuments() * @author Kohsuke Kawaguchi */ public interface SchemaDocument { /** * Gets the system ID of the schema document. * * @return * null if {@link XSOMParser} was not given the system Id. */ String getSystemId(); /** * The namespace that this schema defines. * *

* More precisely, this method simply returns the {@code targetNamespace} attribute * of the schema document. When schemas are referenced in certain ways * (AKA chameleon schema), schema components in this schema document * may end up defining components in other namespaces. * * @return * can be "" but never null. */ String getTargetNamespace(); /** * Gets {@link XSSchema} component that contains all the schema * components defined in this namespace. * *

* The returned {@link XSSchema} contains not just components * defined in this but all the other components * defined in all the schemas that collectively define this namespace. * * @return * never null. */ XSSchema getSchema(); /** * Set of s that are included/imported from this document. * * @return * can be empty but never null. read-only. */ Set getReferencedDocuments(); /** * Gets the s that are included from this document. * * @return * can be empty but never null. read-only. * this set is always a subset of {@link #getReferencedDocuments()}. */ Set getIncludedDocuments(); /** * Gets the s that are imported from this document. * * @param targetNamespace * The namespace URI of the import that you want to * get s for. * @return * can be empty but never null. read-only. * this set is always a subset of {@link #getReferencedDocuments()}. */ Set getImportedDocuments(String targetNamespace); /** * Returns true if this document includes the given document. * *

* Note that this method returns false if this document * imports the given document. */ boolean includes(SchemaDocument doc); /** * Returns true if this document imports the given document. * *

* Note that this method returns false if this document * includes the given document. */ boolean imports(SchemaDocument doc); /** * Set of s that include/import this document. * *

* This works as the opposite of {@link #getReferencedDocuments()}. * * @return * can be empty but never null. read-only. */ Set getReferers(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy