Merge pull request #323 from apache/SmallCleanup

Small changes needed in master before the next set of PRs.
tree: 67c86cba2b1201eb66d19c3ad3746fc9cd884cb7
  1. .gitignore
  2. .travis.yml
  3. DISCLAIMER-WIP
  4. LICENSE
  5. NOTICE
  6. README.md
  7. pom.xml
  8. src/
  9. tools/
README.md

Build Status Maven Central Language grade: Java Total alerts Coverage Status

=================

DataSketches Core Java Library Component

This is the core Java component of the DataSketches library. It contains all of the sketching algorithms and can be accessed directly from user applications.

This component is also a dependency of other components of the library that create adaptors for target systems, such as Hadoop Pig and Hadoop Hive.

Note that we have a parallel core component for C++ and Python implementations of the same sketch algorithms, incubator-datasketches-cpp.

Please visit the main DataSketches website for more information.

If you are interested in making contributions to this site please see our Community page for how to contact us.


Build Instructions

NOTE: This component accesses resource files for testing. As a result, the directory elements of the full absolute path of the target installation directory must qualify as Java identifiers. In other words, the directory elements must not have any space characters (or non-Java identifier characters) in any of the path elements. This is required by the Oracle Java Specification in order to ensure location-independent access to resources: See Oracle Location-Independent Access to Resources

JDK8 is required to compile

This DataSketches component is pure Java and you must compile using JDK 8.

Recommended Build Tool

This DataSketches component is structured as a Maven project and Maven is the recommended Build Tool.

There are two types of tests: normal unit tests and tests run by the strict profile.

To run normal unit tests:

$ mvn clean test

To run the strict profile tests:

$ mvn clean test -P strict

To install jars built from the downloaded source:

$ mvn clean install -DskipTests=true

This will create the following jars:

  • datasketches-java-X.Y.Z-incubating.jar The compiled main class files.
  • datasketches-java-X.Y.Z-incubating-tests.jar The compiled test class files.
  • datasketches-java-X.Y.Z-incubating-sources.jar The main source files.
  • datasketches-java-X.Y.Z-incubating-test-sources.jar The test source files
  • datasketches-java-X.Y.Z-incubating-javadoc.jar The compressed Javadocs.

Dependencies

Run-time

There is one run-time dependency:

  • org.apache.datasketches : datasketches-memory

Testing

See the pom.xml file for test dependencies.


Disclaimer: Apache DataSketches is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.