A Fluent Java API for Cascading
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
etc
fluid-api-runtime
fluid-api
fluid-cascading25
fluid-cascading26
fluid-cascading27
fluid-cascading30
fluid-generator
.gitignore
LICENSE.txt
README.md
build.gradle
settings.gradle
version.properties

README.md

Fluid - A Fluent Java API for Cascading

Overview

Fluid is an API library exposing the Cascading library as a Fluent API.

    // Fluid has factories for all Operations (Functions, Filters, Aggregators, and Buffers)
    Function splitter = Fluid.function()
      .RegexSplitter()
      .fieldDeclaration( fields( "num", "char" ) )
      .patternString( " " )
      .end();

    // Use Fluid to start an assembly builder for chaining Pipes into complex assemblies
    AssemblyBuilder.Start assembly = Fluid.assembly();

    Pipe pipeLower = assembly
      .startBranch( "lower" )
      .each( fields( "line" ) ).function( splitter ).outgoing( Fields.RESULTS )
      .completeBranch();

    Pipe pipeUpper = assembly
      .startBranch( "upper" )
      .each( fields( "line" ) ).function( splitter ).outgoing( Fields.RESULTS )
      .completeBranch();

    Pipe coGroup = assembly
      .startCoGroup()
      .lhs( pipeLower ).lhsGroupFields( fields( "num" ) )
      .rhs( pipeUpper ).rhsGroupFields( fields( "num" ) )
      .declaredFields( fields( "num1", "char1", "num2", "char2" ) )
      .joiner( new OuterJoin() )
      .createCoGroup();

    assembly
      .continueBranch( "result", coGroup )
      .retain( fields( "num1", "char1" ) )
      .rename( Fields.ALL, fields( "num", "char" ) )
      .completeBranch();

    // Capture all the unattached tail pipes
    Pipe[] tails = assembly.completeAssembly();

    FlowDef flowDef = flowDef()
      .addSource( "lower", sourceLower )
      .addSource( "upper", sourceUpper )
      .addSink( "result", sink )
      .addTails( tails );

The Fluid API is generated directly from Cascading compiled libraries.

Code generation dramatically reduces the amount of maintenance required, and will ultimately allow any third-party classes to also have Fluent APIs generated through the build process.

To use Fluid, there is no installation. All Fluid libraries are available through the Conjars.org Maven repository.

Learning the API

Current release Java docs can be found here:

Note that there is only one entry point, the Fluid class.

Your IDE should offer auto complete suggestions after calling the initial factory methods. And for the most part, only methods will be suggested that would logically be next in the chain. Fluid strives to not add any new concepts to its API and to only mirror Cascading concepts, so familiarity with Cascading should be sufficient, but is at least required.

Also Cascading for the Impatient has been ported to Fluid.

This is part 6 using the Fluid API:

The source to the complete ported Impatient series:

Using with Maven/Ivy/Gradle

It is strongly recommended developers pull Fluid from our Maven compatible jar repository Conjars.org.

You can find the latest public releases here:

Three dependencies must be added to the project settings.

First, the fluid-api which contains the root Fluid class.

Second, the dependency that corresponds to the version of Cascading you wish to use. This artifact already has a dependency on a particular version of Cascading. You can override this in your project to get a later maintenance release. But do not mix/match major/minor releases this way.

Source and Javadoc artifacts (using the appropriate classifier) are also available through Conjars.

All Fluid artifacts are built with JDK 1.7 (though they are likely JDK 1.6 source compatible).

Third, Fluid depends on Flapi. If you are using Maven/Ivy/Gradle or similar then you may need to add the Maven repository at http://www.unquietcode.com/maven/releases to your build definition and the necessary Flapi jars will be included in your project.

Flapi is also hosted on Conjars, so the above typically isn't necessary.

Design Notes

Please comment on the mail list for suggestions, or prototype them in tests and pull requests.

The primary goal of Fluid is:

To allow not only hard things to be possible, but to keep simple things simple

Thus our design goals are:

  • Easy entry and exit from the fluent API with existing Cascading objects
  • Mirror the existing Cascading library as much as possible to minimize the number of concepts to be learned
  • Allow custom Cascading classes to have fluent APIs generated within any Cascading based project
  • Provide tools to allow for (more productive) higher order internal DSLs to be created and distributed

The last point is important. Fluid is not meant to compete with Scalding and Cascalog, but should allow users who wish to stay in Java-land the opportunity to use a self guiding API and/or craft special purpose APIs for particular needs.

Code generation is possible because Cascading has a clear uniform convention to how Pipe and Operation classes are defined, and through the Java ConstructorProperties Annotation set on every core object constructors. This includes SubAssemblies which are treated as regular Pipes, and thus are chained.

In the near term, we hope to have a gradle plugin for generating APIs from existing code to be released with those libraries.

In time we hope Fluid will provide a base for incorporating Java 8 lambdas.

Reporting Issues

The best way to report an issue is to mail the mailing list with a clear description.

If verified as a potential issues, add a new test along with the expected result set and submit a pull request on GitHub.

Failing that, feel free to open an issue on the Cascading/Fluid project site.

Developing

Fluid currently requires Gradle 1.11 to build.

Running:

> gradle idea

from the root of the project will create all IntelliJ project and module files, and retrieve all dependencies.

Fluid is based on the open-source project UnquietCode/Flapi.

WIP Releases

Work in progress (WIP) code can be found on GitHub, under a branch named wip-x.y. Final releases will be branches named x.y, for a given release version.

WIP builds, if available, can generally be found on conjars.org, see above, or:

Current wip Java docs can be found here:

Notes

  • There currently are no builders for Tap or Scheme types
  • We plan to provide a gradle plugin for API generation in a future release
  • Driven does support applications built in Fluid