org.apache.brooklyn.core.typereg

Class AbstractTypePlanTransformer

java.lang.Object

org.apache.brooklyn.core.typereg.AbstractTypePlanTransformer

All Implemented Interfaces:

ManagementContextInjectable, BrooklynTypePlanTransformer

Direct Known Subclasses:

CampTypePlanTransformer, JavaClassNameTypePlanTransformer

public abstract class AbstractTypePlanTransformer
extends java.lang.Object
implements BrooklynTypePlanTransformer

Convenience supertype for BrooklynTypePlanTransformer instances.

This supplies a default scoreForType(RegisteredType, RegisteredTypeLoadingContext) method which returns 1 if the format code matches, and otherwise branches to two methods scoreForNullFormat(Object, RegisteredType, RegisteredTypeLoadingContext) and scoreForNonmatchingNonnullFormat(String, Object, RegisteredType, RegisteredTypeLoadingContext) which subclasses can implement. (Often the implementation of the latter is 0.)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	create(RegisteredType type, RegisteredTypeLoadingContext context) delegates to more specific abstract create methods, and performs common validation and customisation of the items created.
java.lang.String	getFormatCode()
java.lang.String	getFormatDescription()
java.lang.String	getFormatName()
double	scoreForType(RegisteredType type, RegisteredTypeLoadingContext context) Determines how appropriate is this transformer for the RegisteredType.getPlan() of the type.
void	setManagementContext(ManagementContext mgmt) Sets the ManagementContext reference.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.core.typereg.BrooklynTypePlanTransformer

createFromTypeDefinition, scoreForTypeDefinition

Method Detail

setManagementContext

public void setManagementContext(ManagementContext mgmt)

Description copied from interface: ManagementContextInjectable

Sets the ManagementContext reference.

Specified by:

setManagementContext in interface ManagementContextInjectable

getFormatCode

public java.lang.String getFormatCode()

Specified by:

getFormatCode in interface BrooklynTypePlanTransformer

Returns:

An identifier for the transformer. This may be used by RegisteredType instances to target a specific transformer.

getFormatName

public java.lang.String getFormatName()

Specified by:

getFormatName in interface BrooklynTypePlanTransformer

Returns:

A display name for this transformer. This may be used to prompt a user what type of plan they are supplying.

getFormatDescription

public java.lang.String getFormatDescription()

Specified by:

getFormatDescription in interface BrooklynTypePlanTransformer

Returns:

A description for this transformer

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

scoreForType

public double scoreForType(RegisteredType type,
                           RegisteredTypeLoadingContext context)

Description copied from interface: BrooklynTypePlanTransformer

Determines how appropriate is this transformer for the RegisteredType.getPlan() of the type. The framework guarantees arguments are nonnull, and that the RegisteredType.getPlan() is also not-null. However many fields on the RegisteredType may be null, including RegisteredType.getId() for an ad hoc creation (eg if invoked from BrooklynTypeRegistry.createBeanFromPlan(String, Object, RegisteredTypeLoadingContext, Class))

Specified by:

scoreForType in interface BrooklynTypePlanTransformer

Returns:

A co-ordinated score / confidence value in the range 0 to 1. 0 means not compatible, 1 means this is clearly the intended transformer and no others need be tried (for instance because the format is explicitly specified), and values between 0 and 1 indicate how likely a transformer believes it should be used.

Values greater than 0.5 are generally reserved for the presence of marker tags or files which strongly indicate that the format is compatible. Such a value should be returned even if the plan is not actually parseable, but if it looks like a user error which prevents parsing (eg mal-formed YAML) and the transformer could likely be the intended target.

create

public java.lang.Object create(RegisteredType type,
                               RegisteredTypeLoadingContext context)

delegates to more specific abstract create methods, and performs common validation and customisation of the items created.

this includes:

setting the AbstractBrooklynObjectSpec.catalogItemId(String)

Specified by:

create in interface BrooklynTypePlanTransformer