#919 - io.ebean package initial

src/main/java/io/ebeaninternal/extraddl/model/DdlScript.java

@@ -0,0 +1,101 @@
+package io.ebeaninternal.extraddl.model;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlAttribute;
+import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.XmlType;
+import javax.xml.bind.annotation.XmlValue;
+
+
+/**
+ * <p>Java class for anonymous complex type.
+ * <p>
+ * <p>The following schema fragment specifies the expected content contained within this class.
+ * <p>
+ * <pre>
+ * &lt;complexType>
+ *   &lt;simpleContent>
+ *     &lt;extension base="&lt;http://www.w3.org/2001/XMLSchema>string">
+ *       &lt;attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
+ *       &lt;attribute name="platforms" type="{http://www.w3.org/2001/XMLSchema}string" />
+ *     &lt;/extension>
+ *   &lt;/simpleContent>
+ * &lt;/complexType>
+ * </pre>
+ */
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "", propOrder = {
+  "value"
+})
+@XmlRootElement(name = "ddl-script")
+public class DdlScript {
+
+  @XmlValue
+  protected String value;
+  @XmlAttribute(name = "name", required = true)
+  protected String name;
+  @XmlAttribute(name = "platforms")
+  protected String platforms;
+
+  /**
+   * Gets the value of the value property.
+   *
+   * @return possible object is
+   * {@link String }
+   */
+  public String getValue() {
+    return value;
+  }
+
+  /**
+   * Sets the value of the value property.
+   *
+   * @param value allowed object is
+   *              {@link String }
+   */
+  public void setValue(String value) {
+    this.value = value;
+  }
+
+  /**
+   * Gets the value of the name property.
+   *
+   * @return possible object is
+   * {@link String }
+   */
+  public String getName() {
+    return name;
+  }
+
+  /**
+   * Sets the value of the name property.
+   *
+   * @param value allowed object is
+   *              {@link String }
+   */
+  public void setName(String value) {
+    this.name = value;
+  }
+
+  /**
+   * Gets the value of the platforms property.
+   *
+   * @return possible object is
+   * {@link String }
+   */
+  public String getPlatforms() {
+    return platforms;
+  }
+
+  /**
+   * Sets the value of the platforms property.
+   *
+   * @param value allowed object is
+   *              {@link String }
+   */
+  public void setPlatforms(String value) {
+    this.platforms = value;
+  }
+
+}

src/main/java/io/ebeaninternal/extraddl/model/ExtraDdl.java

@@ -0,0 +1,66 @@
+package io.ebeaninternal.extraddl.model;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.XmlType;
+import java.util.ArrayList;
+import java.util.List;
+
+
+/**
+ * <p>Java class for anonymous complex type.
+ * <p>
+ * <p>The following schema fragment specifies the expected content contained within this class.
+ * <p>
+ * <pre>
+ * &lt;complexType>
+ *   &lt;complexContent>
+ *     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
+ *       &lt;sequence>
+ *         &lt;element ref="{http://ebean-orm.github.io/xml/ns/extraddl}ddl-script" maxOccurs="unbounded"/>
+ *       &lt;/sequence>
+ *     &lt;/restriction>
+ *   &lt;/complexContent>
+ * &lt;/complexType>
+ * </pre>
+ */
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "", propOrder = {
+  "ddlScript"
+})
+@XmlRootElement(name = "extra-ddl")
+public class ExtraDdl {
+
+  @XmlElement(name = "ddl-script", required = true)
+  protected List<DdlScript> ddlScript;
+
+  /**
+   * Gets the value of the ddlScript property.
+   * <p>
+   * <p>
+   * This accessor method returns a reference to the live list,
+   * not a snapshot. Therefore any modification you make to the
+   * returned list will be present inside the JAXB object.
+   * This is why there is not a <CODE>set</CODE> method for the ddlScript property.
+   * <p>
+   * <p>
+   * For example, to add a new item, do as follows:
+   * <pre>
+   *    getDdlScript().add(newItem);
+   * </pre>
+   * <p>
+   * <p>
+   * <p>
+   * Objects of the following type(s) are allowed in the list
+   * {@link DdlScript }
+   */
+  public List<DdlScript> getDdlScript() {
+    if (ddlScript == null) {
+      ddlScript = new ArrayList<>();
+    }
+    return this.ddlScript;
+  }
+
+}

src/main/java/io/ebeaninternal/extraddl/model/ExtraDdlXmlReader.java

@@ -0,0 +1,83 @@
+package io.ebeaninternal.extraddl.model;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBException;
+import javax.xml.bind.Unmarshaller;
+import java.io.InputStream;
+
+/**
+ * Read ExtraDdl from an XML document.
+ */
+public class ExtraDdlXmlReader {
+
+  private static final Logger logger = LoggerFactory.getLogger(ExtraDdlXmlReader.class);
+
+  /**
+   * Return the combined extra DDL that should be run given the platform name.
+   */
+  public static String buildExtra(String platformName) {
+
+    ExtraDdl read = ExtraDdlXmlReader.read("/extra-ddl.xml");
+    if (read == null) {
+      return null;
+    }
+    StringBuilder sb = new StringBuilder(300);
+    for (DdlScript script : read.getDdlScript()) {
+      if (matchPlatform(platformName, script.getPlatforms())) {
+        logger.debug("include script {}", script.getName());
+        sb.append(script.getValue()).append("\n");
+      }
+    }
+    return sb.toString();
+  }
+
+  /**
+   * Return true if the script platforms is a match/supported for the given platform.
+   *
+   * @param platformName The database platform we are generating/running DDL for
+   * @param platforms    The platforms (comma delimited) this script should run for
+   */
+  public static boolean matchPlatform(String platformName, String platforms) {
+    if (platforms == null || platforms.trim().isEmpty()) {
+      return true;
+    }
+    String[] names = platforms.split("[,;]");
+    for (String name : names) {
+      if (name.trim().toLowerCase().contains(platformName)) {
+        return true;
+      }
+    }
+    return false;
+  }
+
+  /**
+   * Read and return a ExtraDdl from an xml document at the given resource path.
+   */
+  public static ExtraDdl read(String resourcePath) {
+
+    InputStream is = ExtraDdlXmlReader.class.getResourceAsStream(resourcePath);
+    if (is == null) {
+      // we expect this and check for null
+      return null;
+    }
+    return read(is);
+  }
+
+  /**
+   * Read and return a ExtraDdl from an xml document.
+   */
+  public static ExtraDdl read(InputStream is) {
+
+    try {
+      JAXBContext jaxbContext = JAXBContext.newInstance(ExtraDdl.class);
+      Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
+      return (ExtraDdl) unmarshaller.unmarshal(is);
+
+    } catch (JAXBException e) {
+      throw new RuntimeException(e);
+    }
+  }
+}

src/main/java/io/ebeaninternal/extraddl/model/ObjectFactory.java

@@ -0,0 +1,43 @@
+package io.ebeaninternal.extraddl.model;
+
+import javax.xml.bind.annotation.XmlRegistry;
+
+
+/**
+ * This object contains factory methods for each
+ * Java content interface and Java element interface
+ * generated in the io.ebeaninternal.extraddl.model package.
+ * <p>An ObjectFactory allows you to programatically
+ * construct new instances of the Java representation
+ * for XML content. The Java representation of XML
+ * content can consist of schema derived interfaces
+ * and classes representing the binding of schema
+ * type definitions, element declarations and model
+ * groups.  Factory methods for each of these are
+ * provided in this class.
+ */
+@XmlRegistry
+public class ObjectFactory {
+
+
+  /**
+   * Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: io.ebeaninternal.extraddl.model
+   */
+  public ObjectFactory() {
+  }
+
+  /**
+   * Create an instance of {@link DdlScript }
+   */
+  public DdlScript createDdlScript() {
+    return new DdlScript();
+  }
+
+  /**
+   * Create an instance of {@link ExtraDdl }
+   */
+  public ExtraDdl createExtraDdl() {
+    return new ExtraDdl();
+  }
+
+}

src/main/java/io/ebeaninternal/extraddl/model/package-info.java

@@ -0,0 +1,2 @@
+@javax.xml.bind.annotation.XmlSchema(namespace = "http://ebean-orm.github.io/xml/ns/extraddl", elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED)
+package io.ebeaninternal.extraddl.model;