Faceted Project Framework

The project has been created. Please visit the project page.

Introduction

Faceted Project Framework is a mature component of Eclipse Web Tools Platform (WTP) that facilitates treating Eclipse projects as composed of units of functionality (called facets) that can be easily added or removed by users. This is a proposal to move this framework from WTP to a standalone project so that it can be accessed by Eclipse Projects that do not have a natural dependency on WTP.

The Faceted Project Framework is a proposed open-source project under the Eclipse Development Process, and will incubate under the top-level Technology project. This proposal is posted here to solicit community feedback and additional project participation. You are invited to comment on and/or join the project. Please send all feedback to the eclipse.fproj newsgroup.

Creation Review

  • The projection creation review has been scheduled for December 10th, 2008.
  • The communication channel for the review is the newsgroup. Use the newsgroup to post any comments or to request the review to be held on a conference call.

Scope

The Faceted Project Framework project would be chartered with making it possible for developers to build modular projects where functionality can be easily added and removed by the user in a standard way. It will further be charted with providing the integration story between Faceted Project Framework and other technologies at Eclipse in situations where doing so would substantially broaden the applicability of the framework.

Here are some of the key requirements:

  • Reduce the need for creation of specialized project wizards for different variants of what is essentially the same project type by facilitating creation of flexible wizards that allow user to select among various optional project components.
  • Reduce the need for creation of adhoc "Enable X functionality" project actions by providing a centralized facility for managing functionality that's enabled in a project.
  • Provide a way to accurately model tooling capabilities as they map to capabilities of a target platform. Prevent user from accidentally using techology that's incompatible with user's target platform.

Initial Components

The project would be initially composed of two components:

  1. Core Framework
    1. API for building facets and manipulating faceted projects.
    2. UI for manipulating faceted projects. Includes a project properties page for adding and removing facets and a base wizard implementation for creating new faceted projects.
    3. Documentation for writing facets.
  2. JDT Enablement
    1. Java facet that's built around JDT's Java Project Nature.
    2. Modeling of runtimes that are JVM-based.
    3. Tools for making it easier to build facets for Java-based technologies. Includes tools for helping facets manage libraries.

Relationship with Other Eclipse Projects

Faceted Project Framework leverages Resources and UI frameworks from Eclipse Platform. Facets provide a functional superset over Project Natures (part of the Eclipse Platform Resources). Projects taking advantage of the Faceted Project Framework can choose to rely solely on it or mix facets and natures. The mixing scenario is particularly important in cases where an existing code base already uses natures and backwards compatibility needs to be maintained. In those situation facets can serve as wrappers around natures.

There is a possibility that a deeper integration with Eclipse Platform will happen as there has been some interest from the E4 project.

JDT Enablement component leverages various API provided by the JDT project.

WTP would be the main consumer of artifacts produced by this project for immediate future.

Organization

Initial Committers

The initial committers for this component would be:
  • Konstantin Komissarchik, Oracle, proposed project lead: Konstantin works on Oracle Enterprise Pack for Eclipse commercial product and has been a committer on Eclipse Web Tools Platform since the first release. At WTP, his biggest contribution has been the design and implementation of the Faceted Project Framework (subject of this proposal), but he is also involved in several other areas. He leads WTP Common Tools project and is a member of the Technology Project PMC.

Project Mentors (from Architecture Council)

  • Neil Hauge, Oracle, leads Dali JPA Tools project
  • Oisin Hurley, Progress Software, leads SOA Tools project

Code Contributions

The initial code contribution will come from Eclipse Web Tools Platform project.

Interested Parties

WTP, Eclipse IAM, STP, PDT

Developer Community

Developers who start out leveraging this framework might eventually contribute bug fixes and features.

User Community

This project will not provide functionality that can be directly consumed by end-users. Users of this project will be developers at other Eclipse Projects as well as developers in the broader Eclipse Community.

Project Plan

The first release of this project will be aggressively scheduled to line up with Galileo Simultaneous Release (June 2009). The primary goals of the first release will be to (a) refactor code contribution from WTP into project's namespace, (b) eliminate several years worth of deprecated API from the code base, and (c) other work necessary to get established as an independent project.

Concurrently with the above work, a change will be prepared to alter the version of the Faceted Project Framework in WTP to become a shell that delegates to the new framework. It is absolute requirement that the existing API is not broken and continues to behave as before. This will be verified both via automated tests as well as via in-depth manual tests. Any interested adopters will be given this patch if they wish to test in the context of their products. The precise details and time of adoption of this project by WTP will be worked out by WTP. Note that adoption can only happen once this project has exited incubation.



Copyright (c) 2008 Oracle
Made available under Eclipse Public License v1.0