EGF Engine
Release 0.1.0

org.eclipse.egf.pde.reader
Class WorkspaceFactoryComponentReader

java.lang.Object
  extended by org.eclipse.egf.pde.reader.PdeAbstractReader
      extended by org.eclipse.egf.pde.reader.WorkspaceFactoryComponentReader
All Implemented Interfaces:
IFactoryComponentReader
Direct Known Subclasses:
PdeTargetPlatformReader

public class WorkspaceFactoryComponentReader
extends PdeAbstractReader
implements IFactoryComponentReader

This implementation reads EGF elements in using PDE services.
It is typically used to retrieve factory components defined in projects located in the workspace.


Constructor Summary
WorkspaceFactoryComponentReader()
           
 
Method Summary
static WorkspaceFactoryComponentReader getDefault()
          Return a shared default instance.
 IContextDescriptor readContext(String contextId_p, String factoryComponentId_p)
          Read a context description for given ids.
 IContractDescriptor readContract(String contractId_p, String factoryComponentId_p)
          Read a contract description for given ids.
 IContractElementReferenceDescriptor readContractElementReference(String contractReferenceId_p, String factoryComponentId_p)
          Read a contract element reference for given ids.
protected  IDescriptor readDescriptor(CreateDescriptorOperation createDescriptorOperation_p)
          Read a descriptor according to given create descriptor operation.
 IFactoryComponentDescriptor readFactoryComponent(IProject project_p)
          Read a factory component description from given project.
 IFactoryComponentInvocationDescriptor readFactoryComponentInvocation(String factoryComponentInvocation_p, String factoryComponentId_p)
          Read a factory component invocation description for given ids.
 IDescriptor readMappings(String factoryComponentId_p)
          Read all mappings for given factory component.
 IDescriptor readPatternLibraries(String fcId_p)
          Read all pattern libraries for given factory component.
 IProductionPlanDescriptor readProductionPlan(String productionPlanId_p, String factoryComponentId_p)
          Read a production plan description for given ids.
 ITaskFactoryDescriptor readTaskFactory(String taskFactoryId_p, String factoryComponentId_p)
          Read a task factory for given ids.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WorkspaceFactoryComponentReader

public WorkspaceFactoryComponentReader()
Method Detail

getDefault

public static WorkspaceFactoryComponentReader getDefault()
Return a shared default instance.

Returns:

readFactoryComponent

public IFactoryComponentDescriptor readFactoryComponent(IProject project_p)
Read a factory component description from given project.

Specified by:
readFactoryComponent in interface IFactoryComponentReader
Parameters:
project_p -
Returns:
an FactoryComponentDescriptor instance or null if data are not found.

readProductionPlan

public IProductionPlanDescriptor readProductionPlan(String productionPlanId_p,
                                                    String factoryComponentId_p)
Description copied from interface: IFactoryComponentReader
Read a production plan description for given ids.

Specified by:
readProductionPlan in interface IFactoryComponentReader
Returns:
an IProductionPlanDescriptor instance or null if data are not found.
See Also:
IFactoryComponentReader.readProductionPlan(java.lang.String, java.lang.String)

readFactoryComponentInvocation

public IFactoryComponentInvocationDescriptor readFactoryComponentInvocation(String factoryComponentInvocation_p,
                                                                            String factoryComponentId_p)
Description copied from interface: IFactoryComponentReader
Read a factory component invocation description for given ids.

Specified by:
readFactoryComponentInvocation in interface IFactoryComponentReader
Returns:
an IFactoryComponentInvocationDescriptor instance or null if data are not found.
See Also:
IFactoryComponentReader.readFactoryComponentInvocation(java.lang.String, java.lang.String)

readContract

public IContractDescriptor readContract(String contractId_p,
                                        String factoryComponentId_p)
Description copied from interface: IFactoryComponentReader
Read a contract description for given ids.

Specified by:
readContract in interface IFactoryComponentReader
Returns:
an IContractDescriptor instance or null if data are not found.
See Also:
IFactoryComponentReader.readContract(java.lang.String, java.lang.String)

readContext

public IContextDescriptor readContext(String contextId_p,
                                      String factoryComponentId_p)
Description copied from interface: IFactoryComponentReader
Read a context description for given ids.

Specified by:
readContext in interface IFactoryComponentReader
Returns:
an IContextDescriptor instance or null if data are not found.
See Also:
IFactoryComponentReader.readContext(java.lang.String, java.lang.String)

readTaskFactory

public ITaskFactoryDescriptor readTaskFactory(String taskFactoryId_p,
                                              String factoryComponentId_p)
Description copied from interface: IFactoryComponentReader
Read a task factory for given ids.

Specified by:
readTaskFactory in interface IFactoryComponentReader
Returns:
an ITaskFactoryDescriptor instance or null if data are not found.
See Also:
IFactoryComponentReader.readTaskFactory(java.lang.String, java.lang.String)

readPatternLibraries

public IDescriptor readPatternLibraries(String fcId_p)
Description copied from interface: IFactoryComponentReader
Read all pattern libraries for given factory component.

Specified by:
readPatternLibraries in interface IFactoryComponentReader
Returns:
an IDescriptor instance or null if data are not found.
See Also:
IFactoryComponentReader.readPatternLibraries(java.lang.String)

readMappings

public IDescriptor readMappings(String factoryComponentId_p)
Description copied from interface: IFactoryComponentReader
Read all mappings for given factory component.

Specified by:
readMappings in interface IFactoryComponentReader
Returns:
an IDescriptor instance or null if data are not found.
See Also:
IFactoryComponentReader.readMappings(java.lang.String)

readContractElementReference

public IContractElementReferenceDescriptor readContractElementReference(String contractReferenceId_p,
                                                                        String factoryComponentId_p)
Description copied from interface: IFactoryComponentReader
Read a contract element reference for given ids.

Specified by:
readContractElementReference in interface IFactoryComponentReader
Returns:
an IContractElementReferenceDescriptor instance or null if data are not found.
See Also:
IFactoryComponentReader.readContractElementReference(java.lang.String, java.lang.String)

readDescriptor

protected IDescriptor readDescriptor(CreateDescriptorOperation createDescriptorOperation_p)
Description copied from class: PdeAbstractReader
Read a descriptor according to given create descriptor operation.

Overrides:
readDescriptor in class PdeAbstractReader
Returns:
See Also:
PdeAbstractReader.readDescriptor(org.eclipse.egf.pde.reader.CreateDescriptorOperation)

EGF Engine
Release 0.1.0

Copyright (c) Thales Corporate Services S.A.S, 2009.

This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.