Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "API catalog"
(→Content Model Annotations) |
(→Overview) |
||
| (23 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
=Overview= | =Overview= | ||
| − | This page enumerates the catalog of API that will be released in | + | This page enumerates the catalog of API that will be released in WTP 3.0. The API is divided into four categories: full, graduating, provisional and obsolete. Full API is framework that was declared as full API in a release prior to WTP 3.0. Graduating API is framework that was considered provisional in previous releases (or was only added in the current release) and is now ready to graduate into full API status. Provisional (new) API is framework has not had enough adopter soak time, but which is ready for wider adoption and refinement before being moved fully API. Obsolete API is framework that has been replaced by new framework or is being deprecated out of existence. |
| − | == | + | ==Full API== |
The following lists the API that will graduate from provisional to full in Europa: | The following lists the API that will graduate from provisional to full in Europa: | ||
| Line 11: | Line 11: | ||
'''Plugin:''' org.eclipse.jst.jsf.common | '''Plugin:''' org.eclipse.jst.jsf.common | ||
| − | '''Packages:''' org.eclipse.jst.jsf.common | + | '''Packages:''' org.eclipse.jst.jsf.common.util |
'''Purpose:''' Provides utility classes for manipulating JDT IType's, primarily as Java Beans. | '''Purpose:''' Provides utility classes for manipulating JDT IType's, primarily as Java Beans. | ||
| Line 19: | Line 19: | ||
'''Plugin:''' org.eclipse.jst.jsf.common | '''Plugin:''' org.eclipse.jst.jsf.common | ||
| − | '''Packages:''' org.eclipse.jst.jsf.common.context (all | + | '''Packages:''' org.eclipse.jst.jsf.common.context (all except context.symbols and internals) |
'''Purpose:''' Provides a generic way to describe specific instance contexts within an arbitrary model and derive orthogonal information about that context through related resolvers (for example, your context is an absolute position in an XML file. What project are you in? What is your owning element). | '''Purpose:''' Provides a generic way to describe specific instance contexts within an arbitrary model and derive orthogonal information about that context through related resolvers (for example, your context is an absolute position in an XML file. What project are you in? What is your owning element). | ||
| − | === | + | ===Design-Time Application Framework=== |
| − | '''Plugin:''' org.eclipse.jst.jsf. | + | '''Plugin:''' org.eclipse.jst.jsf.core |
| − | '''Packages:''' org.eclipse.jst.jsf. | + | '''Packages:''' org.eclipse.jst.jsf.core.designtime.* |
| − | '''Purpose:''' | + | '''Purpose:''' Simulates certain (currently mainly EL variable/property resolution) JSF runtime behaviours and provides extensibility for adopters to extend this simulation to places where they extend it at runtime (i.e. custom VariableResolver). |
| − | === | + | ===Application Configuration Resource File ("faces-config.xml") Model=== |
| − | '''Plugin:''' org.eclipse.jst.jsf. | + | '''Plugin:''' org.eclipse.jst.jsf.facesconfig |
| − | '''Packages:''' org.eclipse.jst.jsf. | + | '''Packages:''' org.eclipse.jst.jsf.facesconfig.* (except org.eclipse.jst.jsf.facesconfig.internal.*) |
| − | '''Purpose:''' | + | '''Purpose:''' Provides programmatic access and manipulation of the standard JSF application configuration resource file (e.g. "faces-config.xml"). |
| + | |||
| + | ==Graduating API== | ||
| + | |||
| + | ==Provisional API== | ||
| + | |||
| + | The following lists the API that will graduate from internal to provisional API in Europa: | ||
===Content Model Type System=== | ===Content Model Type System=== | ||
| Line 43: | Line 49: | ||
'''Plugin:''' org.eclipse.jst.jsf.core | '''Plugin:''' org.eclipse.jst.jsf.core | ||
| − | '''Packages:''' org.eclipse.jst.jsf.core.metadataprocessors | + | '''Packages:''' org.eclipse.jst.jsf.core.metadataprocessors.*, org.eclipse.jst.jsf.core.taglibprocessing.* |
'''Purpose:''' An entensible system for define expected types and valid value ranges on JSF tag attributes for use in end-user features like content assist and validation. | '''Purpose:''' An entensible system for define expected types and valid value ranges on JSF tag attributes for use in end-user features like content assist and validation. | ||
| − | + | '''Code tagged as provisional:''' [[Image:Questionmark.gif]] | |
| − | + | ===EL Symbol Framework=== | |
| + | |||
| + | '''Plugin:''' org.eclipse.jst.jsf.common | ||
| + | |||
| + | '''Packages:''' org.eclipse.jst.jsf.common.context | ||
| + | |||
| + | '''Purpose:''' Provides a framework through which to describe EL symbols (model objects, methods, functions, EL variables) at design time in order to analyze EL expression for such purposes as validation and content assist. | ||
| + | |||
| + | '''Code tagged as provisional:''' [[Image:Checkmark.gif]] | ||
===Designtime Meta-data Framework=== | ===Designtime Meta-data Framework=== | ||
| Line 59: | Line 73: | ||
'''Purpose:''' Provides a rich, user-extensible repository for design-time metadata. | '''Purpose:''' Provides a rich, user-extensible repository for design-time metadata. | ||
Obsoletes: Meta-data framework for 0.5 as well as Sybase contributed metadata for pagedesigner. | Obsoletes: Meta-data framework for 0.5 as well as Sybase contributed metadata for pagedesigner. | ||
| + | |||
| + | '''Code tagged as provisional:''' [[Image:Questionmark.gif]] | ||
=== Tag Identification === | === Tag Identification === | ||
| − | TODO | + | |
| + | '''Plugins:''' org.eclipse.jst.jsf.common (possibly org.eclipse.jst.jsf.core) | ||
| + | |||
| + | '''Packages:''' org.eclipse.jst.jsf.common.dom (and possibly parts of org.eclipse.jst.jsf.core.internal.tld) | ||
| + | |||
| + | '''Purpose:''' TODO | ||
| + | |||
| + | '''Code tagged as provisional:''' [[Image:Checkmark.gif]] | ||
=== Axiomatic Sets === | === Axiomatic Sets === | ||
| Line 70: | Line 93: | ||
'''Purpose:''' Extends java.util.Set to provide sets of objects that support mathematically axiomatic operations like union and intersection as well as broader operations like mappings (functions) and constraints. JSF Core implements JSF tag specific sets and operations. | '''Purpose:''' Extends java.util.Set to provide sets of objects that support mathematically axiomatic operations like union and intersection as well as broader operations like mappings (functions) and constraints. JSF Core implements JSF tag specific sets and operations. | ||
| + | |||
| + | '''Code tagged as provisional:''' [[Image:Checkmark.gif]] | ||
===Tag Conversion Framework=== | ===Tag Conversion Framework=== | ||
| − | '''Plugins:''' org.eclipse.jst | + | '''Plugins:''' org.eclipse.jst.pagedesigner |
| − | '''Packages:''' org.eclipse.jst | + | '''Packages:''' org.eclipse.jst.pagedesigner.dtmanager, including all non-"internal" sub-packages |
'''Purpose:''' Allows tag developers to contribute information to the Web Page Designer so that custom components can be rendered more faithfully on the design canvas. | '''Purpose:''' Allows tag developers to contribute information to the Web Page Designer so that custom components can be rendered more faithfully on the design canvas. | ||
| + | |||
| + | '''Code tagged as provisional:''' [[Image:Checkmark.gif]] | ||
===Element Edit Framework=== | ===Element Edit Framework=== | ||
| Line 83: | Line 110: | ||
'''Plugins:''' org.eclipse.jst.jsf.pagedesigner | '''Plugins:''' org.eclipse.jst.jsf.pagedesigner | ||
| − | '''Packages:''' | + | '''Packages:''' org.eclipse.jst.pagedesigner.elementedit (but not "html" and "jsp" sub-packages) |
'''Purpose:''' Allows third-party tag contributors to add custom end-user behaviour (i.e. context menus) to Web Page Editor specific to their component's requires. | '''Purpose:''' Allows third-party tag contributors to add custom end-user behaviour (i.e. context menus) to Web Page Editor specific to their component's requires. | ||
| − | + | '''Code tagged as provisional:''' [[Image:Questionmark.gif]] | |
| − | + | ===JSF Library Registry=== | |
| + | |||
| + | '''Plugins:''' org.eclipse.jst.jsf.core | ||
| + | |||
| + | '''Packages:''' org.eclipse.jst.jsf.core.jsflibraryregistry | ||
| + | |||
| + | '''Purpose:''' Allows the JSFDeveloper to define named sets of jars on the class and deploy paths. Also allows ToolsDeveloper and ComponentDeveloper to add plugin-contributed named sets of jars. | ||
| + | |||
| + | '''Code tagged as provisional:''' [[Image:Checkmark.gif]] | ||
| + | |||
| + | ===JSF Library Configuration=== | ||
| + | |||
| + | '''Plugins:''' org.eclipse.jst.jsf.core | ||
| + | |||
| + | '''Packages:''' org.eclipse.jst.jsf.core.jsflibraryconfiguration | ||
| + | |||
| + | '''Purpose:''' Allows the ToolsDeveloper to check for JSF Library references on a project. | ||
| + | |||
| + | '''Code tagged as provisional:''' [[Image:Questionmark.gif]] | ||
| + | |||
| + | ===Application Configuration Manager === | ||
| + | |||
| + | '''Plugin:''' org.eclipse.jst.jsf.core | ||
| + | |||
| + | '''Packages:''' org.eclipse.jst.jsf.core.jsfappconfig | ||
| + | |||
| + | '''Purpose:''' Aggregates all application configuration models that can be detected as being in the classpath at designtime to provide a unified view of how the a JSF project will be configured at runtime. | ||
| + | |||
| + | '''Code tagged as provisional:''' [[Image:Checkmark.gif]] | ||
| + | |||
| + | === WPE Taglib Properties Viewers=== | ||
| + | |||
| + | '''Plugin:''' org.eclipse.jst.jsf.pagedesigner | ||
| + | |||
| + | '''Packages:''' org.eclipse.jst.pagedesigner.editors.properties, org.eclipse.jst.pagedesigner.editors.properties.quickedittabsections | ||
| + | |||
| + | '''Purpose:''' Provides means of displaying tag attributes and their values in the Web Page Editor. | ||
| + | |||
| + | '''Code tagged as provisional:''' [[Image:Checkmark.gif]] | ||
==Obsolete API == | ==Obsolete API == | ||
| Line 102: | Line 167: | ||
'''Migration:''' Use the new Meta-Data Framework. | '''Migration:''' Use the new Meta-Data Framework. | ||
| + | |||
| + | [[Category:Eclipse Web Tools Platform Project]] | ||
Latest revision as of 18:44, 20 May 2008
Contents
- 1 Overview
- 1.1 Full API
- 1.2 Graduating API
- 1.3 Provisional API
- 1.3.1 Content Model Type System
- 1.3.2 EL Symbol Framework
- 1.3.3 Designtime Meta-data Framework
- 1.3.4 Tag Identification
- 1.3.5 Axiomatic Sets
- 1.3.6 Tag Conversion Framework
- 1.3.7 Element Edit Framework
- 1.3.8 JSF Library Registry
- 1.3.9 JSF Library Configuration
- 1.3.10 Application Configuration Manager
- 1.3.11 WPE Taglib Properties Viewers
- 1.4 Obsolete API
Overview
This page enumerates the catalog of API that will be released in WTP 3.0. The API is divided into four categories: full, graduating, provisional and obsolete. Full API is framework that was declared as full API in a release prior to WTP 3.0. Graduating API is framework that was considered provisional in previous releases (or was only added in the current release) and is now ready to graduate into full API status. Provisional (new) API is framework has not had enough adopter soak time, but which is ready for wider adoption and refinement before being moved fully API. Obsolete API is framework that has been replaced by new framework or is being deprecated out of existence.
Full API
The following lists the API that will graduate from provisional to full in Europa:
Design-Time Type Utilities
Plugin: org.eclipse.jst.jsf.common
Packages: org.eclipse.jst.jsf.common.util
Purpose: Provides utility classes for manipulating JDT IType's, primarily as Java Beans.
Model Context Framework
Plugin: org.eclipse.jst.jsf.common
Packages: org.eclipse.jst.jsf.common.context (all except context.symbols and internals)
Purpose: Provides a generic way to describe specific instance contexts within an arbitrary model and derive orthogonal information about that context through related resolvers (for example, your context is an absolute position in an XML file. What project are you in? What is your owning element).
Design-Time Application Framework
Plugin: org.eclipse.jst.jsf.core
Packages: org.eclipse.jst.jsf.core.designtime.*
Purpose: Simulates certain (currently mainly EL variable/property resolution) JSF runtime behaviours and provides extensibility for adopters to extend this simulation to places where they extend it at runtime (i.e. custom VariableResolver).
Application Configuration Resource File ("faces-config.xml") Model
Plugin: org.eclipse.jst.jsf.facesconfig
Packages: org.eclipse.jst.jsf.facesconfig.* (except org.eclipse.jst.jsf.facesconfig.internal.*)
Purpose: Provides programmatic access and manipulation of the standard JSF application configuration resource file (e.g. "faces-config.xml").
Graduating API
Provisional API
The following lists the API that will graduate from internal to provisional API in Europa:
Content Model Type System
Plugin: org.eclipse.jst.jsf.core
Packages: org.eclipse.jst.jsf.core.metadataprocessors.*, org.eclipse.jst.jsf.core.taglibprocessing.*
Purpose: An entensible system for define expected types and valid value ranges on JSF tag attributes for use in end-user features like content assist and validation.
Code tagged as provisional: 
EL Symbol Framework
Plugin: org.eclipse.jst.jsf.common
Packages: org.eclipse.jst.jsf.common.context
Purpose: Provides a framework through which to describe EL symbols (model objects, methods, functions, EL variables) at design time in order to analyze EL expression for such purposes as validation and content assist.
Code tagged as provisional: 
Designtime Meta-data Framework
Plugin: org.eclipse.jst.jsf.common
Packages: org.eclipse.jst.jsf.common.metadata.internal.provisional.*, org.eclipse.jst.jsf.common.metadata.traittypes.traittypes.internal.provisional.*
Purpose: Provides a rich, user-extensible repository for design-time metadata. Obsoletes: Meta-data framework for 0.5 as well as Sybase contributed metadata for pagedesigner.
Code tagged as provisional:
Tag Identification
Plugins: org.eclipse.jst.jsf.common (possibly org.eclipse.jst.jsf.core)
Packages: org.eclipse.jst.jsf.common.dom (and possibly parts of org.eclipse.jst.jsf.core.internal.tld)
Purpose: TODO
Code tagged as provisional:
Axiomatic Sets
Plugins: org.eclipse.jst.jsf.common, org.eclipse.jst.jsf.core
Packages: org.eclipse.jst.jsf.common.sets.internal.provisional.*, org.eclipse.jst.jsf.core.sets.internal.provisional.*
Purpose: Extends java.util.Set to provide sets of objects that support mathematically axiomatic operations like union and intersection as well as broader operations like mappings (functions) and constraints. JSF Core implements JSF tag specific sets and operations.
Code tagged as provisional:
Tag Conversion Framework
Plugins: org.eclipse.jst.pagedesigner
Packages: org.eclipse.jst.pagedesigner.dtmanager, including all non-"internal" sub-packages
Purpose: Allows tag developers to contribute information to the Web Page Designer so that custom components can be rendered more faithfully on the design canvas.
Code tagged as provisional:
Element Edit Framework
Plugins: org.eclipse.jst.jsf.pagedesigner
Packages: org.eclipse.jst.pagedesigner.elementedit (but not "html" and "jsp" sub-packages)
Purpose: Allows third-party tag contributors to add custom end-user behaviour (i.e. context menus) to Web Page Editor specific to their component's requires.
Code tagged as provisional:
JSF Library Registry
Plugins: org.eclipse.jst.jsf.core
Packages: org.eclipse.jst.jsf.core.jsflibraryregistry
Purpose: Allows the JSFDeveloper to define named sets of jars on the class and deploy paths. Also allows ToolsDeveloper and ComponentDeveloper to add plugin-contributed named sets of jars.
Code tagged as provisional:
JSF Library Configuration
Plugins: org.eclipse.jst.jsf.core
Packages: org.eclipse.jst.jsf.core.jsflibraryconfiguration
Purpose: Allows the ToolsDeveloper to check for JSF Library references on a project.
Code tagged as provisional:
Application Configuration Manager
Plugin: org.eclipse.jst.jsf.core
Packages: org.eclipse.jst.jsf.core.jsfappconfig
Purpose: Aggregates all application configuration models that can be detected as being in the classpath at designtime to provide a unified view of how the a JSF project will be configured at runtime.
Code tagged as provisional:
WPE Taglib Properties Viewers
Plugin: org.eclipse.jst.jsf.pagedesigner
Packages: org.eclipse.jst.pagedesigner.editors.properties, org.eclipse.jst.pagedesigner.editors.properties.quickedittabsections
Purpose: Provides means of displaying tag attributes and their values in the Web Page Editor.
Code tagged as provisional:
Obsolete API
Content Model Annotations
Plugin: org.eclipse.jst.jsf.common
Packages: org.eclipse.jst.jsf.common.annotation.internal.provisional.*
Purpose: Provides content model annotation meta-data.
Migration: Use the new Meta-Data Framework.