org.eclipse.emfforms.bazaar.internal

Class BazaarImpl<T>

java.lang.Object

org.eclipse.emfforms.bazaar.internal.BazaarImpl<T>

Type Parameters:

T - the type of product produced by this Bazaar

All Implemented Interfaces:

Bazaar<T>

Direct Known Subclasses:

ThreadSafeBazaar

public class BazaarImpl<T>
extends Object
implements Bazaar<T>

Implementation of a Bazaar using the IEclipseContext for dependency injection.

Author:

jonas

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.emfforms.bazaar.Bazaar

Bazaar.Builder<T>, Bazaar.PriorityOverlapCallBack<T>

Constructor Summary

Constructors

Constructor and Description
BazaarImpl()

Method Summary

Modifier and Type	Method and Description
void	addContextFunction(String key, BazaarContextFunction contextFunction) Adds a BazaarContextFunction to this Bazaar to exchange existing parameters to a parameter requested by a Vendor.
org.eclipse.e4.core.contexts.IEclipseContext	addContextFunctions(org.eclipse.e4.core.contexts.IEclipseContext context) Transforms all BazaarContextFunctions to IContextFunctions and attaches those to an IEclipseContext.
void	addVendor(Vendor<? extends T> vendor) Adds a Vendor to the bazaar.
boolean	checkPreConditions(Vendor<? extends T> vendor, org.eclipse.e4.core.contexts.IEclipseContext context) Checks the Preconditions for a given vendor.
org.eclipse.e4.core.contexts.IEclipseContext	createEclipseContext(BazaarContext bazaarContext) Creates an IEclipseContext from a BazaarContext.
T	createProduct(BazaarContext bazaarContext) Creates a product of type T, provided by the Vendor with the highest Bid and which is statisfied by the parameters in the BazaarContext.
T	createProduct(Vendor<? extends T> vendor, org.eclipse.e4.core.contexts.IEclipseContext context) Returns the product which is provided with the highest priority by any Vendor.
List<T>	createProducts(BazaarContext bazaarContext) Creates a list of products of type T, provided by Vendors which are statisfied by the parameters in the BazaarContext, ordered by their Bid.
Vendor<? extends T>	getBestVendor(org.eclipse.e4.core.contexts.IEclipseContext context)
void	removeVendor(Vendor<? extends T> vendor) Removes a Vendor from the bazaar.
void	setPriorityOverlapCallBack(Bazaar.PriorityOverlapCallBack<? super T> priorityOverlapCallBack) Adds a Bazaar.PriorityOverlapCallBack, see Bazaar.PriorityOverlapCallBack.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BazaarImpl

public BazaarImpl()

Method Detail

addVendor

public void addVendor(Vendor<? extends T> vendor)

Description copied from interface: Bazaar

Adds a Vendor to the bazaar. Will be queried if a product is requested, the best fitting will create the product. Has no effect if the vendor is already present in this bazaar.

Specified by:

addVendor in interface Bazaar<T>

Parameters:

vendor - the Vendor

removeVendor

public void removeVendor(Vendor<? extends T> vendor)

Description copied from interface: Bazaar

Removes a Vendor from the bazaar. Has no effect if the vendor is not present in this bazaar.

Specified by:

removeVendor in interface Bazaar<T>

Parameters:

vendor - the Vendor to remove

createProduct

public T createProduct(Vendor<? extends T> vendor,
                       org.eclipse.e4.core.contexts.IEclipseContext context)

Returns the product which is provided with the highest priority by any Vendor.

Parameters:

vendor - The Vendor creating the product

context - The IEclipseContext to inject parameters for creating a product (see Create)

Returns:

T the created product

addContextFunctions

public org.eclipse.e4.core.contexts.IEclipseContext addContextFunctions(org.eclipse.e4.core.contexts.IEclipseContext context)

Transforms all BazaarContextFunctions to IContextFunctions and attaches those to an IEclipseContext.

Parameters:

context - the IEclipseContext to attache IContextFunctions to

Returns:

the IEclipseContext with attached IContextFunction

createEclipseContext

public org.eclipse.e4.core.contexts.IEclipseContext createEclipseContext(BazaarContext bazaarContext)

Creates an IEclipseContext from a BazaarContext. If the bazaar context contains an Eclipse context, then it is used and will have all other values set into it from the bazaar context.

Parameters:

bazaarContext - the BazaarContext to get key / values from

Returns:

a IEclipseContext containign all key / values provided by the BazaarContext

getBestVendor

public Vendor<? extends T> getBestVendor(org.eclipse.e4.core.contexts.IEclipseContext context)

Parameters:

context - the Eclipse injection context

Returns:

obtains the best available vendor for the give context

setPriorityOverlapCallBack

public void setPriorityOverlapCallBack(Bazaar.PriorityOverlapCallBack<? super T> priorityOverlapCallBack)

Description copied from interface: Bazaar

Adds a Bazaar.PriorityOverlapCallBack, see Bazaar.PriorityOverlapCallBack.

Specified by:

setPriorityOverlapCallBack in interface Bazaar<T>

Parameters:

priorityOverlapCallBack - a PriorityOverlapCallBack

addContextFunction

public void addContextFunction(String key,
                               BazaarContextFunction contextFunction)

Description copied from interface: Bazaar

Adds a BazaarContextFunction to this Bazaar to exchange existing parameters to a parameter requested by a Vendor.

Specified by:

addContextFunction in interface Bazaar<T>

Parameters:

key -

contextFunction -

createProduct

public T createProduct(BazaarContext bazaarContext)

Description copied from interface: Bazaar

Creates a product of type T, provided by the Vendor with the highest Bid and which is statisfied by the parameters in the BazaarContext. In case of tied bids, the Bazaar.PriorityOverlapCallBack if one is set will be notified of which vendor is chosen to break the tie. Note that during the bidding process, ties may have to be broken in this way that are later defeated by a higher bid.

Specified by:

createProduct in interface Bazaar<T>

Parameters:

bazaarContext - the BazaarContext, which is used to provide requested parameters for Vendor

Returns:

the product provided by the best Vendor

See Also:

Bazaar.createProduct(org.eclipse.emfforms.bazaar.BazaarContext)

createProducts

public List<T> createProducts(BazaarContext bazaarContext)

Description copied from interface: Bazaar

Creates a list of products of type T, provided by Vendors which are statisfied by the parameters in the BazaarContext, ordered by their Bid. Ties are not broken as all bids are successful and are used only for ordering.

Specified by:

createProducts in interface Bazaar<T>

Parameters:

bazaarContext - the BazaarContext, which is used to provide requested parameters for Vendor

Returns:

a list of products ordered by the highest Bid

See Also:

Bazaar.createProducts(org.eclipse.emfforms.bazaar.BazaarContext)

checkPreConditions

public boolean checkPreConditions(Vendor<? extends T> vendor,
                                  org.eclipse.e4.core.contexts.IEclipseContext context)

Checks the Preconditions for a given vendor.

Parameters:

vendor - The Vendor to check the Precondition for.

context - The IEclipseContext to provide the Precondition

Returns:

whether the Preconditions are fulfilled