com.ibm.wsdl.extensions.schema.SchemaImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of libre-wsdl4j Show documentation

Open and Free WSDL library: Web Services Description Language. Libre-wsdl4j is a fork of WSDL4J 1.6.3. WSL4j is a Java stub generator for WSDL. Many software projects still depends on WSL4j, so the idea is that libre-wsdl4j should be an actively maintained version of this software on GitHub. "WSDL, that's an anchronym i haven't heard in almost ten years." Still big in the enterprise world" - comments on the Internet.

The newest version!

/*
 * (c) Copyright IBM Corp 2004, 2005 
 */

package com.ibm.wsdl.extensions.schema;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.wsdl.extensions.schema.Schema;
import javax.wsdl.extensions.schema.SchemaImport;
import javax.wsdl.extensions.schema.SchemaReference;
import javax.xml.namespace.QName;
import org.w3c.dom.Element;

/**
 * This class is used to wrap schema elements. It holds the DOM Element to the <schema> element.
 * 
 * @see SchemaSerializer
 * @see SchemaDeserializer
 * 
 * @author Jeremy Hughes 
 */
public class SchemaImpl implements Schema {
  private QName elementType = null;
  // Uses the wrapper type so we can tell if it was set or not.
  private Boolean required = null;
  private Element element = null;

  public static final long serialVersionUID = 1;

  /*
   * imports is a Map of Lists with key of the import's namespace URI. Each List contains the SchemaImport objects for that namespace. There can be more than one SchemaImport in a List - one for each schemaLocation attribute setting.
   */
  private final Map> imports = new HashMap<>();

  /*
   * includes is a List of Include objects for the targetNamespace of the enclosing schema. There is one Include in the List for each  element in the XML Schema.
   */
  private final List includes = new ArrayList<>();

  /*
   * redefines is a list of Redefine obejcts for the targetNamespace of the enclosing schema. There is one Redefine in the List for each  element in the XML Schema.
   */
  private final List redefines = new ArrayList<>();

  private String documentBaseURI = null;

  /**
   * Get a map of lists containing all the imports defined here. The map's keys are Strings representing the namespace URIs, and the map's values are lists. There is one list for each namespace URI for which imports have been defined.
   * 
   * @return a Map of Lists of Import instances keyed off the import's namespace
   */
  public Map> getImports() {
    return this.imports;
  }

  /**
   * Create a new schema import.
   * 
   * @return the newly created schema import
   */
  public SchemaImport createImport() {
    return new SchemaImportImpl();
  }

  /**
   * Add an import to this LightWeightSchema
   * 
   * @param importSchema
   *          the import to be added
   */
  public void addImport(SchemaImport importSchema) {
    String namespaceURI = importSchema.getNamespaceURI();
    List importList = this.imports.computeIfAbsent(namespaceURI, key -> new ArrayList<>());
    importList.add(importSchema);
  }

  /**
   * Get list of includes defined here.
   * 
   * @return a List of SchemaReference instances representing the schema includes.
   */

  public List getIncludes() {
    return this.includes;
  }

  public SchemaReference createInclude() {
    return new SchemaReferenceImpl();
  }

  public void addInclude(SchemaReference includeSchema) {
    this.includes.add(includeSchema);
  }

  public List getRedefines() {
    return this.redefines;
  }

  public SchemaReference createRedefine() {
    return new SchemaReferenceImpl();
  }

  public void addRedefine(SchemaReference redefineSchema) {
    this.redefines.add(redefineSchema);
  }

  @Override
  public String toString() {
    StringBuilder strBuf = new StringBuilder();

    strBuf.append("SchemaExtensibilityElement (" + this.elementType + "):");
    strBuf.append("\nrequired=" + this.required);

    if (this.element != null) {
      strBuf.append("\nelement=" + this.element);
    }

    return strBuf.toString();
  }

  /**
   * Set the type of this extensibility element.
   *
   * @param elementType
   *          the type
   */
  @Override
  public void setElementType(QName elementType) {
    this.elementType = elementType;
  }

  /**
   * Get the type of this extensibility element.
   *
   * @return the extensibility element's type
   */
  public QName getElementType() {
    return elementType;
  }

  /**
   * Set whether or not the semantics of this extension are required. Relates to the wsdl:required attribute.
   */
  @Override
  public void setRequired(Boolean required) {
    this.required = required;
  }

  /**
   * Get whether or not the semantics of this extension are required. Relates to the wsdl:required attribute.
   */
  public Boolean getRequired() {
    return required;
  }

  /**
   * Set the DOM Element that represents this schema element.
   *
   * @param element
   *          the DOM element representing this schema
   */
  @Override
  public void setElement(Element element) {
    this.element = element;
  }

  /**
   * Get the DOM Element that represents this schema element.
   *
   * @return the DOM element representing this schema
   */
  public Element getElement() {
    return element;
  }

  /**
   * Set the document base URI of this schema definition. Can be used to represent the origin of the schema, and can be exploited when resolving relative URIs (e.g. in <import>s).
   * 
   * @param documentBaseURI
   *          the document base URI of this schema
   */
  @Override
  public void setDocumentBaseURI(String documentBaseURI) {
    this.documentBaseURI = documentBaseURI;
  }

  /**
   * Get the document base URI of this schema
   * 
   * @return the document base URI
   */
  public String getDocumentBaseURI() {
    return this.documentBaseURI;
  }
}