| /* |
| * Copyright (c) 1998, 2021 Oracle and/or its affiliates. All rights reserved. |
| * |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License v. 2.0 which is available at |
| * http://www.eclipse.org/legal/epl-2.0, |
| * or the Eclipse Distribution License v. 1.0 which is available at |
| * http://www.eclipse.org/org/documents/edl-v10.php. |
| * |
| * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause |
| */ |
| |
| // Contributors: |
| // Oracle - initial API and implementation from Oracle TopLink |
| package org.eclipse.persistence.sdo.helper; |
| |
| import java.util.List; |
| import java.util.Map; |
| import javax.xml.namespace.QName; |
| import javax.xml.transform.Source; |
| import commonj.sdo.Property; |
| import commonj.sdo.helper.HelperContext; |
| import commonj.sdo.helper.XSDHelper; |
| |
| /** |
| * <p><b>Purpose</b>: Provides access to additional information when the Type or Property is defined by an XML Schema (XSD). |
| * <p><b>Responsibilities</b>:<ul> |
| * <li> Define methods define Types from an XSD. |
| * <li> Generate methods generate an XSD from Types. |
| * <li> Other Methods return null/false for exception conditions. |
| * </ul> |
| */ |
| public interface SDOXSDHelper extends XSDHelper { |
| |
| /** |
| * INTERNAL: |
| * |
| * @param qname |
| * @param isElement |
| * @return |
| */ |
| Property getGlobalProperty(QName qname, boolean isElement); |
| |
| /** |
| * INTERNAL: |
| * |
| * @param xsdSource |
| * @param schemaResolver |
| * @return |
| */ |
| List define(Source xsdSource, SchemaResolver schemaResolver); |
| |
| /** |
| * INTERNAL: |
| * |
| * @param types |
| * @param schemaLocationResolver |
| * @return |
| */ |
| String generate(List types, SchemaLocationResolver schemaLocationResolver); |
| |
| /** |
| * INTERNAL: |
| * |
| * @param appInfoElements |
| * @return |
| */ |
| Map buildAppInfoMap(List appInfoElements); |
| |
| /** |
| * INTERNAL: |
| * Return the helperContext that this instance is associated with. |
| * |
| * @return |
| */ |
| HelperContext getHelperContext(); |
| |
| /** |
| * INTERNAL: |
| * Set the helperContext that this instance is associated with. |
| * |
| * @param helperContext |
| */ |
| void setHelperContext(HelperContext helperContext); |
| |
| /** |
| * INTERNAL: |
| * |
| */ |
| void reset(); |
| |
| /** |
| * INTERNAL: |
| * |
| * @param qname |
| * @param prop |
| * @param isElement |
| * Register the given property with the given qname. |
| */ |
| void addGlobalProperty(QName qname, Property prop, boolean isElement); |
| } |