com.sapportals.wcm.repository.service.layout.customizing.flavor

Interface IFlavor

All Known Subinterfaces:

IPropertiesFlavor

public interface IFlavor

A context consists of some context properties and can be used to classifiy a property

Method Summary

int	compareWeight(IFlavor impFlavor) Compares the ranking of the current Flavor to the impFlavor .
IFlavorProperty	getValue(IFlavorPropertyDef def) Get the Value attribute of the Flavor object.
boolean	isMatching(IFlavor impFlavor) Checks whether the impFlavor matches the current context.

Method Detail

getValue

public IFlavorProperty getValue(IFlavorPropertyDef def)

Get the Value attribute of the Flavor object.

Parameters:

def - @todo: Description of the incoming method parameter

Returns:

The Value value

isMatching

public boolean isMatching(IFlavor impFlavor)

Checks whether the impFlavor matches the current context. This is checked by comparing all context properties of the current context. For each property of the current context, which is set, the properties of the impFlavor are compared. When one of the impFlavor's properties is not equal to the same property of the current context and is no wildcard, it is considered as not matching.

Parameters:

impFlavor - The context to be checked

Returns:

True, if the impFlavor matches the current context.

compareWeight

public int compareWeight(IFlavor impFlavor)

Compares the ranking of the current Flavor to the impFlavor . The ranking is compared property by property. Each property has a ranking and a value. The value might either be a normal value or one of the constants FlavorPropertyDef.NOVALUE or FlavorPropertyDef.WILDCARD . A the WILDCARD has a higher weight than a normal value and a normal value has a higher weight than the NOVALUE. So the properties are sorted by their ranking and than the wight of their values are compared. The result is determined by the first property where the weight of the values differs. A positive integer is returned, when the current Flavor has a higher weighted value than the impFlavor at the first differing property, a negative integer is returned otherwise. A zero value is returned, when the weight of all properties is equal. A realistic result can only be achived, when this.isMatching(impFlavor) returnes true, for impFlavor.

Parameters:

impFlavor - the context to compare with

Returns:

a positive integer, if the current context has a higher weight than the impFlavor, zero , when the weight is equal, a negative integer otherwise