Code Enhancement with Java 8, minor fix

- enhanced code with java 8 constructs
- fixed build path of documents

Signed-off-by: Philipp Heisig <philipp.heisig@fh-dortmund.de>
3 files changed
tree: c7d9acd5b98ed694caf390fff8c5c2842642e507
  1. .gitignore
  2. .travis.yml
  3. CapraArchitecture.png
  4. README.md
  5. description
  6. index.html
  7. org.eclipse.capra.core/
  8. org.eclipse.capra.documentation/
  9. org.eclipse.capra.feature/
  10. org.eclipse.capra.generic.persistence/
  11. org.eclipse.capra.generic.priority/
  12. org.eclipse.capra.generic.tracemodels/
  13. org.eclipse.capra.handler.cdt/
  14. org.eclipse.capra.handler.emf/
  15. org.eclipse.capra.handler.file/
  16. org.eclipse.capra.handler.gef/
  17. org.eclipse.capra.handler.hudson/
  18. org.eclipse.capra.handler.jdt/
  19. org.eclipse.capra.handler.mylyn/
  20. org.eclipse.capra.handler.papyrus/
  21. org.eclipse.capra.handler.reqIf/
  22. org.eclipse.capra.releng.p2/
  23. org.eclipse.capra.releng.target/
  24. org.eclipse.capra.testsuite/
  25. org.eclipse.capra.ui.notification/
  26. org.eclipse.capra.ui.plantuml/
  27. org.eclipse.capra.ui/
  28. org.eclipse.capra.variability.tracemetamodel/
  29. pom.xml
README.md

Capra - A Traceability Management Tool

Background

Capra is a configurable and extendable traceability management tool. It is created in the context of an ITEA funded project called AMALTHEA4Public whose main aim is to develop a platform that will improve the development of embedded multicore and many core systems.

How it works

Capra uses the Eclipse Modelling Framework (EMF) as its base technology and stores the traceability model as an EMF model. The traceability metamodel is not fixed and can be defined by the user. It relies on the Eclipse Extension mechanism and provides an extension point for artifacts types to be supported. To add a new type of artifact, one simply needs to add an extension to this extension point and implement the provided interfaces.

User Guide - End Users

Pre-requisites

Before downloading and using Capra, download Eclipse Modelling Environment and make sure you have the listed dependencies installed.

  • Xcore: Install through Eclipse's “Install new software...” feature
  • Xtend: Install through the Eclipse Market Place

Get the source code

  • Open your Eclipse Environment
  • Go to File >> Import and select Git >> Projects from Git
  • Use the GitHub repository and import all available projects to your workspace
  • All dependencies are listed in the target platform file org.eclipse.capra.releng.target/org.eclipse.capra.releng.target.target. Set it as the active target platform by opening it and clicking on “Set as Target Platform” in the upper right corner. Eclipse will now download all dependencies. Note that this will take a while. Check the progress in the lower right corner.
  • Build your workspace
  • Make sure that all the projects have no errors.
  • Click on Run >> Run Configurations and create a new Eclipse Application Configuration
  • Select your running workspace
  • Click Finish
  • Once the new workspace opens, create or import projects that you want to use to create traceability links
  • Go to perspectives and switch to the Capra perspective
  • Now you can create traceability links as described in Creating Traceability Links.

If compilation errors occur during the first build, check if any of the dependencies above are missing. Cleaning all binaries also often helps resolve issues.

Run Capra

  • Make sure that all the projects have no errors.
  • Click on Run --> Run Configurations and create a new Eclipse Application Configuration
  • Select your running workspace
  • Click “Apply”, then “Run”
  • Once the new workspace opens, create or import projects that you want to use to create traceability links
  • Go to perspectives and switch to the Capra perspective
  • Follow this video to create and visualize traceability links
    NOTE: For better resolution, download the video first.

How to Extend the Tool - For Developers

Building

Install Maven. Run maven in the root folder:

mvn clean verify

Before committing

Please make sure that all points in the following checklist are fullfilled before committing your work to a Capra repository:

  • The code is formatted according to the built-in Eclipse code formatting rules.
  • All classes and all public methods are documented.
  • Each source code file has a copyright header (see below).
  • The imports are organised.

Organisation of imports and code formatting can be automated by selecting them as save actions for the Java editor in the Eclipse preferences.

Adding new source files

It is important to maintain the correct copyright messages, indicating the contributors of each file and that it is covered by the EPL. You can use automation to insert a correct copyright header.

Install the Eclipse Releng Tools. They contain the copyright tool. Use the following copyright header:

Copyright (c) ${date} Chalmers | University of Gothenburg, rt-labs and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
 
  Contributors:
     Chalmers | University of Gothenburg and rt-labs - initial API and implementation and/or initial documentation

The Contributors entry can be replaced with the appropriate names. Use “Fix copyrights” from the context menu to add the copyrights to all relevant files in a project or folder.