FlowMiner

Fine-grained, compact flow summaries for program analysis


Home    Install    Tutorials    Support

If you have not yet installed the FlowMiner Eclipse plugin, do that first.

Mining Summaries

So, you have one or more Java JARs that you want FlowMiner to summarize. Easy!

  1. From the FlowMiner dropdown menu, select Mine and Export.
  2. Use the dialog to select the JAR(s) you want to summarize and click OK.
  3. Use the dialog to select dependency JAR(s) of the libraries you are analyzing. If none, click Cancel. Otherwise select them and click OK.
  4. Use the dialog to select the destination (output file) for the summaries and click OK.
Yes, it is that easy! FlowMiner will automatically mine and export summaries. You can track progress or cancel the job using the Eclipse Progress view, and see messages from FlowMiner in the Eclipse Error Log view.

Importing Summaries

So, you have previously-mined summaries that you want to apply to an Atlas index so they can be used or inspected. Easy!

  1. From the FlowMiner dropdown menu, select either Import into existing index or Import into empty index.
  2. Use the dialog to select the previously saved summary file and click OK.
FlowMiner will automatically import the given summaries and insert them into your Atlas index.

Using FlowMiner Summaries With Another Tool

If you want to use FlowMiner's library summaries from a tool other than Atlas, do the following:

  1. Add edu.iastate.flowminer.io as a dependency and use the Model API to obtain an in-memory document model that can be traversed.
    2. OR
  2. Add edu.iastate.flowminer.io as a dependency and use the Stream API by implementing a custom StreamImporter.
    3. OR
  3. Implement your own parsing for FlowMiner's XML Schema.

Using any of the above methods, import the summaries in whatever form makes sense for your tool. The XML schema provides constructs that are roughly analogous to types in XCSG plus a schema extension whose additional tags and attributes are documented in ISUSchema.