Skip to content
Core Java Sketch Library.
Java
Branch: master
Clone or download
Latest commit 9b09cb3 Nov 8, 2019

README.md

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

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

DataSketches Core Java 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 is a dependency of other components of the library that create adaptors for target systems, such as Hadoop Pig and Hadoop Hive. Please refer to our website for more comprehensive information about the various sketching algorithms and how to use them.

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

Documentation

DataSketches Library Website

Java Core Overview

Java Core Javadocs

Downloading Latest Release

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

Zip File from Apache Archive

Jar Files from Maven Central

GitHub

Build Instructions

JDK8 is Required Compiler

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

Recommended Build Tool

The DataSketches-java component 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.

Resources

Issues for datasketches-java

Forum

Dev mailing list

You can’t perform that action at this time.