Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*

# Java Files #
*.jar

# Intellij Idea
.idea

# Gradle stuff
build/
.gradle/
gradle
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,28 @@ You can clone the code, compile, and build the JAR file the regular command-line
way.

We use [Gradle](https://gradle.org/) for connvenience.
- [install Gradle](https://gradle.org/install)
- **(on Linux or Mac)** run `chmod +x gradlew`
- run `gradle test` for unit tests (currently correctness tests)
- run `gradle build` to find the `apted.jar` file in `build/libs/`

## Deploying to local maven repository

You can publish the project into your local maven repository to import into other projects.

- run `gradle publishToMavenLocal`

To use APTED in another project:

```
repositories {
mavenLocal()
}

dependencies {
compile 'at.unisalzburg:apted:1.0'
}
```

## Javadoc documentation

Run `gradle javadoc` to generate documentation. Then, open in your browser
Expand Down
35 changes: 28 additions & 7 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
group 'at.unisalzburg'
version '1.0'

apply plugin: 'java'
apply plugin: "maven-publish"

// Dependency repository.
repositories {
Expand All @@ -11,13 +15,6 @@ dependencies {
'com.google.code.gson:gson:2.8.0'
}

// Specify main class for the JAR file.
jar {
manifest {
attributes 'Main-Class': 'util.CommandLine'
}
}

// Include test classes and private members into javadoc.
javadoc {
classpath += sourceSets.test.compileClasspath
Expand All @@ -29,3 +26,27 @@ javadoc {
test {
testLogging.showStandardStreams = true
}

// For publishing in MavenLocal
task sourcesJar(type: Jar, dependsOn: "classes") {
classifier = 'sources'

from sourceSets.main.allSource
from sourceSets.test.allSource
}

publishing {
publications {
mavenJava(MavenPublication) {
groupId 'at.unisalzburg'
artifactId 'apted'
version '1.0'

from components.java

artifact sourcesJar {
classifier "sources"
}
}
}
}
Binary file added gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
6 changes: 6 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#Thu May 18 15:43:57 CEST 2017
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-3.2.1-all.zip
172 changes: 172 additions & 0 deletions gradlew

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
* SOFTWARE.
*/

package costmodel;
package at.unisalzburg.apted.costmodel;

import node.Node;
import at.unisalzburg.apted.node.Node;

/**
* This interface specifies the methods to implement for a custom cost model.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,13 @@
* SOFTWARE.
*/

package costmodel;
package at.unisalzburg.apted.costmodel;

import costmodel.CostModel;
import node.Node;
import node.StringNodeData;
import at.unisalzburg.apted.node.Node;
import at.unisalzburg.apted.node.StringNodeData;

/**
* This is a cost model defined on {@link node.StringNodeData} with a fixed cost
* This is a cost model defined on {@link at.unisalzburg.apted.node.StringNodeData} with a fixed cost
* per edit operation.
*/
public class PerEditOperationStringNodeDataCostModel implements CostModel<StringNodeData> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,10 @@
* SOFTWARE.
*/

package costmodel;
package at.unisalzburg.apted.costmodel;

import costmodel.CostModel;
import node.Node;
import node.StringNodeData;
import at.unisalzburg.apted.node.Node;
import at.unisalzburg.apted.node.StringNodeData;

/**
* This is a unit-nost model defined on string labels.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@
* SOFTWARE.
*/

package distance;
package at.unisalzburg.apted.distance;

import java.util.Arrays;
import java.util.LinkedList;
import java.util.Stack;
import node.Node;
import node.NodeIndexer;
import costmodel.CostModel;
import at.unisalzburg.apted.node.Node;
import at.unisalzburg.apted.node.NodeIndexer;
import at.unisalzburg.apted.costmodel.CostModel;

/**
* Implements APTED algorithm [1,2].
Expand Down Expand Up @@ -76,14 +76,14 @@ public class APTED<C extends CostModel, D> {
/**
* Indexer of the source tree.
*
* @see node.NodeIndexer
* @see at.unisalzburg.apted.node.NodeIndexer
*/
private NodeIndexer it1;

/**
* Indexer of the destination tree.
*
* @see node.NodeIndexer
* @see at.unisalzburg.apted.node.NodeIndexer
*/
private NodeIndexer it2;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@
* SOFTWARE.
*/

package distance;
package at.unisalzburg.apted.distance;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import node.Node;
import node.NodeIndexer;
import costmodel.CostModel;
import at.unisalzburg.apted.node.Node;
import at.unisalzburg.apted.node.NodeIndexer;
import at.unisalzburg.apted.costmodel.CostModel;

/**
* Implements an exponential algorithm for the tree edit distance. It computes
Expand All @@ -43,14 +43,14 @@ public class AllPossibleMappingsTED<C extends CostModel, D> {
/**
* Indexer of the source tree.
*
* @see node.NodeIndexer
* @see at.unisalzburg.apted.node.NodeIndexer
*/
private NodeIndexer it1;

/**
* Indexer of the destination tree.
*
* @see node.NodeIndexer
* @see at.unisalzburg.apted.node.NodeIndexer
*/
private NodeIndexer it2;

Expand Down
Loading