Maven Installation

To quote Apache: 'Apache Maven is a software project management and comprehension tool'. The key to the how Maven does it's job is the project object model (POM) file (if you want to know what one of these files looks like, see below -- if you don't care, continue).

Here are several tutorials on how to download the Maven system so you can use it (the first one is from Apache itself):

Choose the one which you are confortable with.

POM file locations in system

The project object model (POM) file file is found at the top of the package directory and has the name pom.xml.

In the JThermodynamics system the pom.xml files are found at the top of each package:

JThermodynamics/JTherGas: (https://github.com/blurock/JThermodynamics/blob/master/JTherGas/pom.xml)
JThermodynamics/JThermodynamicData: (https://github.com/blurock/JThermodynamics/blob/master/JThermodynamicData/pom.xml)
JThermodynamics/JThermodynamicInterface (https://github.com/blurock/JThermodynamics/blob/master/ThermodynamicInterface/pom.xml)

Maven commands

Through the Maven commands, the package can be compiled, packaged and installed. A maven command has the form:

mvn <set of keywords>

Where the keywords can be (copy pasted from here):

validate - validate the project is correct and all necessary information is available
compile - compile the source code of the project
test - test the compiled source code using a suitable unit testing framework. These tests should not require the code be packaged or deployed
package - take the compiled code and package it in its distributable format, such as a JAR.
verify - run any checks on results of integration tests to ensure quality criteria are met
install - install the package into the local repository, for use as a dependency in other projects locally
deploy - done in the build environment, copies the final package to the remote repository for sharing with other developers and projects.

We use the typical command:

mvn clean compile package install

The clean command zeroes the package and starts over.

POM file example

The following is a version of the pom.xml file for the Thermodynamic interface (the link has the current version):

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

  <modelVersion>4.0.0</modelVersion>

  <packaging>war</packaging>

  <version>0.1.0-SNAPSHOT</version>

  <groupId>info.esblurock</groupId>

  <artifactId>thermodynamics</artifactId>

  <properties>

    <appengine.maven.plugin.version>1.3.1</appengine.maven.plugin.version>

    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

    <maven.compiler.source>1.8</maven.compiler.source>

    <maven.compiler.target>1.8</maven.compiler.target>

    <maven.compiler.showDeprecation>true</maven.compiler.showDeprecation>

  </properties>

  <prerequisites>

    <maven>3.3.9</maven>

  </prerequisites>

  <dependencies>

    <!-- Compile/runtime dependencies -->

    <dependency>

      <groupId>javax.servlet</groupId>

      <artifactId>javax.servlet-api</artifactId>

      <version>3.1.0</version>

    </dependency>

    <dependency>

      <groupId>jstl</groupId>

      <artifactId>jstl</artifactId>

      <version>1.2</version>

    </dependency>

    <!-- Test Dependencies -->

    <dependency>

      <groupId>junit</groupId>

      <artifactId>junit</artifactId>

      <version>4.12</version>

      <scope>test</scope>

    </dependency>

    <dependency>

      <groupId>com.google.appengine</groupId>

      <artifactId>appengine-api-1.0-sdk</artifactId>

      <version>1.9.55</version>

    </dependency>

    <dependency>

      <groupId>com.google.gwt</groupId>

      <artifactId>gwt</artifactId>

      <version>2.8.2</version>

      <type>pom</type>

    </dependency>

    <!-- https://mvnrepository.com/artifact/com.google.gwt/gwt-user -->

    <dependency>

      <groupId>com.google.gwt</groupId>

      <artifactId>gwt-user</artifactId>

      <version>2.8.2</version>

    </dependency>

    <!-- https://mvnrepository.com/artifact/com.google.gwt/gwt-dev -->

    <dependency>

      <groupId>com.google.gwt</groupId>

      <artifactId>gwt-dev</artifactId>

      <version>2.8.2</version>

    </dependency>

    <!-- https://mvnrepository.com/artifact/com.google.gwt/gwt-codeserver -->

    <dependency>

      <groupId>com.google.gwt</groupId>

      <artifactId>gwt-codeserver</artifactId>

      <version>2.8.2</version>

    </dependency>

    <dependency>

      <groupId>com.google.gwt</groupId>

      <artifactId>gwt-servlet</artifactId>

      <version>2.8.2</version>

      <scope>runtime</scope>

    </dependency>

    <dependency>

      <groupId>com.github.gwtmaterialdesign</groupId>

      <artifactId>gwt-material</artifactId>

      <version>2.1.1</version>

    </dependency>

    <dependency>

      <groupId>com.github.gwtmaterialdesign</groupId>

      <artifactId>gwt-material-addins</artifactId>

      <version>2.1.1</version>

    </dependency>

    <dependency>

      <groupId>com.github.gwtmaterialdesign</groupId>

      <artifactId>gwt-material-themes</artifactId>

      <version>2.1.1</version>

    </dependency>

    <dependency>

      <groupId>com.github.gwtmaterialdesign</groupId>

      <artifactId>gwt-material-jquery</artifactId>

      <version>2.1.1</version>

    </dependency>

    <dependency>

      <groupId>com.github.gwtmaterialdesign</groupId>

      <artifactId>gwt-material-table</artifactId>

      <version>2.1.1</version>

    </dependency>

    <dependency>

      <groupId>mysql</groupId>

      <artifactId>mysql-connector-java</artifactId>

      <version>8.0.15</version>

    </dependency>

    <dependency>

      <groupId>com.google.cloud.sql</groupId>

      <artifactId>mysql-socket-factory</artifactId>

      <version>1.0.13</version>

    </dependency>

    <!-- https://mvnrepository.com/artifact/org.openscience.cdk/cdk-data -->

    <dependency>

      <groupId>org.openscience.cdk</groupId>

      <artifactId>cdk-bundle</artifactId>

      <version>2.2</version>

    </dependency>

    <dependency>

      <groupId>xml-apis</groupId>

      <artifactId>xml-apis</artifactId>

      <version>1.4.01</version>

    </dependency>

    <dependency>

      <groupId>info.esblurock</groupId>

      <artifactId>JthermodynamicData</artifactId>

      <version>1.0</version>

    </dependency>

  </dependencies>

  <build>

    <resources>

      <resource>

        <directory>src/main/java</directory>

      </resource>

    </resources>    <!-- for hot reload of the web application -->

    <outputDirectory>${project.build.directory}/${project.build.finalName}/WEB-INF/classes</outputDirectory>

    <plugins>

      <plugin>

        <groupId>net.ltgt.gwt.maven</groupId>

        <artifactId>gwt-maven-plugin</artifactId>

        <version>1.0-rc-6</version>

        <executions>

          <execution>

            <goals>

              <goal>compile</goal>

            </goals>

          </execution>

        </executions>

        <configuration>

          <moduleName>info.esblurock.thermodynamics.ThermodynamicsInterface</moduleName>

          <moduleShortName>ThermodynamicsInterface</moduleShortName>

          <failOnError>true</failOnError>

          <!-- GWT compiler 2.8 requires 1.8, hence define sourceLevel here if

            you use a different source language for java compilation -->

          <sourceLevel>1.8</sourceLevel>

          <!-- Compiler configuration -->

          <compilerArgs>

            <!-- Ask GWT to create the Story of Your Compile (SOYC) (gwt:compile) -->

            <arg>-compileReport</arg>

            <arg>-XcompilerMetrics</arg>

          </compilerArgs>

          <!-- DevMode configuration -->

          <warDir>${project.build.directory}/${project.build.finalName}</warDir>

          <classpathScope>compile+runtime</classpathScope>

          <!-- URL(s) that should be opened by DevMode (gwt:devmode). -->

          <runTarget>index.html</runTarget>

        </configuration>

      </plugin>

      <plugin>

        <groupId>com.google.cloud.tools</groupId>

        <artifactId>appengine-maven-plugin</artifactId>

        <version>${appengine.maven.plugin.version}</version>

      </plugin>

    </plugins>

  </build>

</project>

Maven package version

The following is the information about the package version:

<packaging>war</packaging>

  <version>0.1.0-SNAPSHOT</version>

  <groupId>info.esblurock</groupId>

  <artifactId>thermodynamics</artifactId>

Package Dependencies

If you look at the <dependencies> section, you can see all the dependencies for compiling.

For example, this package depends on another package in the JThermodynamic system:

    <dependency>

      <groupId>info.esblurock</groupId>

      <artifactId>JthermodynamicData</artifactId>

      <version>1.0</version>

    </dependency>

When you compile the JThermodynamic system with Maven, a local repository is formed holding the compiled version

Other dependencies, for example other systems can be found. These are retrieved from a central Maven repository like this from the cloud. For example, the ThermodynamicInterface package is dependent on the CDK (Chemical Development Kit):

<dependency>

      <groupId>org.openscience.cdk</groupId>

      <artifactId>cdk-bundle</artifactId>

      <version>2.2</version>

</dependency>

Or, for example, on the mySQL database system:

<dependency>

      <groupId>mysql</groupId>

      <artifactId>mysql-connector-java</artifactId>

      <version>8.0.15</version>

</dependency>

<dependency>

      <groupId>com.google.cloud.sql</groupId>

      <artifactId>mysql-socket-factory</artifactId>

      <version>1.0.13</version>

</dependency>

Google Sites

Report abuse