EGF Engine
Release 0.1.0

org.eclipse.egf.pde.pattern.reader
Interface IPatternExtensionReader

All Known Implementing Classes:
PlatformPatternExtensionReader, WorkspacePatternExtensionReader

public interface IPatternExtensionReader

Pattern extension reader contract.
By default, one implementation is provided per possible source of extensions.


Method Summary
 IDescriptor getPatternLibraries()
          Get all root library descriptors.
 IDescriptor getPatternLibraries(String fcId_p)
          Get all root library descriptors for given factory component id.
 IDescriptor getPatternLibrary(String libraryFullId_p)
          Get library descriptor from its full id.
 

Method Detail

getPatternLibrary

IDescriptor getPatternLibrary(String libraryFullId_p)
Get library descriptor from its full id.
Must be a root library, that is not one contained in another one.
So as to get such libraries, user should be giving the root containing library id and then parse resulting descriptor to reach expected one.
If so, the use of PatternSeeker from pattern plug-in is always recommended.

Parameters:
libraryFullId_p - Can't be null.
Returns:
Null if no root library with given id could be found.

getPatternLibraries

IDescriptor getPatternLibraries()
Get all root library descriptors.
See getPatternLibrary(String) for description of a root library.

Returns:
A descriptor that contains an arbitrary number of container descriptors before reaching root library descriptors.
So as to use this result properly, users should test the descriptor type by calling IDescriptor.getValue(String) with parameter IPatternConstants.PATTERN_EXTENSION_POINT_CHILD_TYPE.
If returned value is different from IPatternConstants.PATTERN_EXTENSION_POINT_CHILD_LIBRARY then a library descriptor is not reached yet.
The first descriptor that returns a correct type is indeed a root library descriptor.
It does not have any children, if none could be found.

getPatternLibraries

IDescriptor getPatternLibraries(String fcId_p)
Get all root library descriptors for given factory component id.
See getPatternLibrary(String) for description of a root library.

Parameters:
fcId_p - The factory component id.
Returns:
A descriptor that contains an arbitrary number of container descriptors before reaching root library descriptors.
So as to use this result properly, users should test the descriptor type by calling IDescriptor.getValue(String) with parameter IPatternConstants.PATTERN_EXTENSION_POINT_CHILD_TYPE.
If returned value is different from IPatternConstants.PATTERN_EXTENSION_POINT_CHILD_LIBRARY then a library descriptor is not reached yet.
The first descriptor that returns a correct type is indeed a root library descriptor.
It does not have any children, if none could be found.

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.