Package net.officefloor.gef.item

Class AbstractProcedureItem<R extends Model,RE extends java.lang.Enum<RE>,O,M extends Model,E extends java.lang.Enum<E>,I extends AbstractProcedureItem<R,RE,O,M,E,I>>

java.lang.Object

net.officefloor.gef.ide.editor.AbstractItem<R,O,R,RE,M,E>

net.officefloor.gef.ide.editor.AbstractConfigurableItem<R,RE,O,M,E,I>

net.officefloor.gef.item.AbstractProcedureItem<R,RE,O,M,E,I>

All Implemented Interfaces:

ConfigurableItem<I>

Direct Known Subclasses:

ActivityProcedureItem, WoofProcedureItem

public abstract class AbstractProcedureItem<R extends Model,RE extends java.lang.Enum<RE>,O,M extends Model,E extends java.lang.Enum<E>,I extends AbstractProcedureItem<R,RE,O,M,E,I>>
extends AbstractConfigurableItem<R,RE,O,M,E,I>

Configuration for the abstract Procedure.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.gef.ide.editor.AbstractConfigurableItem

AbstractConfigurableItem.ConfigurableModelContext<O,M>, AbstractConfigurableItem.IdeConfiguration<O,M extends Model,I>, AbstractConfigurableItem.IdeConfigurer, AbstractConfigurableItem.ItemActioner<O,M>, AbstractConfigurableItem.ItemConfigurer<O,M,I>

Nested classes/interfaces inherited from class net.officefloor.gef.ide.editor.AbstractItem

AbstractItem.ConfigurableContext<R extends Model,O>, AbstractItem.IdeChildrenGroup, AbstractItem.IdeConnection<C extends ConnectionModel>, AbstractItem.IdeConnectionTarget<C extends ConnectionModel,T extends Model,TE extends java.lang.Enum<TE>>, AbstractItem.IdeExtractor, AbstractItem.IdeLabeller, AbstractItem.IdeStyle, AbstractItem.PreferenceListener

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	name	Name.
protected java.util.Map<java.lang.String,java.lang.String>	outputNameMapping	ProcedureFlowType name mapping.
protected java.lang.String	procedure	Procedure name.
protected javafx.collections.ObservableList<Procedure>	procedures	Procedure instances.
protected ProcedureType	procedureType	ProcedureType.
protected PropertyList	properties	PropertyList.
protected java.lang.String	resource	Resource.
protected java.lang.String	sourceName	Source.

Fields inherited from class net.officefloor.gef.ide.editor.AbstractItem

builder

Constructor Summary

Constructors

Constructor	Description
AbstractProcedureItem()

Method Summary

Modifier and Type	Method	Description
protected abstract Change<M>	addProcedure(O operations, java.lang.String name, java.lang.String resource, java.lang.String sourceName, java.lang.String procedure, PropertyList properties, ProcedureType procedureType)	Creates Change to add Procedure.
protected void	children(java.util.List<AbstractItem.IdeChildrenGroup> childGroups)	Loads the AbstractItem.IdeChildrenGroup instances.
AbstractConfigurableItem.IdeConfigurer	configure()	Obtains the item configuration.
protected abstract I	createItem()	Creates the AbstractProcedureItem implementation.
protected abstract AbstractItem<R,O,M,E,?,?>	createNextItem()	Creates the Procedure next AbstractItem implementation.
protected abstract AbstractItem<R,O,M,E,?,?>	createOutputItem()	Creates the Procedure output AbstractItem implementation.
protected abstract java.lang.Class<? extends ConnectionModel>[]	getInputConnectionClasses()	Obtains the input ConnectionModel Class instances.
protected abstract java.lang.String	getProcedureName(M model)	Obtains the Procedure name.
protected abstract PropertyList	getProcedureProperties(M model)	Obtains the Procedure PropertyList.
protected abstract java.lang.String	getResource(M model)	Obtains the resource.
protected abstract java.lang.String	getSectionName(M model)	Obtains the SubSection / OfficeSection name.
protected abstract java.lang.String	getSourceName(M model)	Obtains the source name.
I	item(M model)	Creates an item from the Model.
static <R extends Model,RE extends java.lang.Enum<RE>,O,M extends Model,E extends java.lang.Enum<E>,I extends AbstractProcedureItem<R,RE,O,M,E,I>> void	loadProcedures(ValueValidator.ValueValidatorContext<? extends I,java.lang.String> validatorContext, SelectBuilder<I,Procedure> selectProcedures, EnvironmentBridge envBridge)	Loads the available Procedure instances.
static ProcedureType	loadProcedureType(AbstractProcedureItem<?,?,?,?,?,?> item, EnvironmentBridge envBridge)	Loads the ProcedureType for the AbstractProcedureItem.
protected void	loadStyles(java.util.List<AbstractItem.IdeStyle> styles)	Default implementation of AbstractItem.style() will invoke this to load styles.
protected abstract Change<M>	refactorProcedure(O operations, M model, java.lang.String name, java.lang.String resource, java.lang.String sourceName, java.lang.String procedure, PropertyList properties, ProcedureType procedureType, java.util.Map<java.lang.String,java.lang.String> outputNameMapping)	Creates Change to refactor Procedure.
protected abstract Change<M>	removeProcedure(O operations, M model)	Creates Change to remove Procedure.
javafx.scene.layout.Pane	visual(M model, AdaptedChildVisualFactoryContext<M> context)	Creates the visual for the Model.

Methods inherited from class net.officefloor.gef.ide.editor.AbstractConfigurableItem

createAdaptedParent, extractIdeConfiguration, furtherAdapt

Methods inherited from class net.officefloor.gef.ide.editor.AbstractItem

connections, createChild, extract, furtherAdapt, getBuilder, getChildrenGroups, getConfigurableContext, getConnections, getPreferenceStyleId, init, label, loadToParent, prototype, style, translateFromCommaSeparatedList, translateToCommaSeparateList, translateToNameMappings, translateToPropertyList

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

Name.

resource

protected java.lang.String resource

Resource.

procedures

protected javafx.collections.ObservableList<Procedure> procedures

Procedure instances.

sourceName

protected java.lang.String sourceName

Source.

procedure

protected java.lang.String procedure

Procedure name.

properties

protected PropertyList properties

PropertyList.

procedureType

protected ProcedureType procedureType

ProcedureType.

outputNameMapping

protected java.util.Map<java.lang.String,java.lang.String> outputNameMapping

ProcedureFlowType name mapping.

Constructor Detail

AbstractProcedureItem

public AbstractProcedureItem()

Method Detail

loadProcedures

public static <R extends Model,RE extends java.lang.Enum<RE>,O,M extends Model,E extends java.lang.Enum<E>,I extends AbstractProcedureItem<R,RE,O,M,E,I>> void loadProcedures(ValueValidator.ValueValidatorContext<? extends I,java.lang.String> validatorContext,
                                                                                                                                                                                                                                          SelectBuilder<I,Procedure> selectProcedures,
                                                                                                                                                                                                                                          EnvironmentBridge envBridge)
                                                                                                                                                                                                                                   throws java.lang.Exception

Loads the available Procedure instances.

Parameters:

validatorContext - ValueValidator.ValueValidatorContext.

selectProcedures - Builder for selecting the Procedure.

envBridge - EnvironmentBridge.

Throws:

java.lang.Exception - If fails to load available Procedure instances.

loadProcedureType

public static ProcedureType loadProcedureType(AbstractProcedureItem<?,?,?,?,?,?> item,
                                              EnvironmentBridge envBridge)
                                       throws java.lang.Exception

Loads the ProcedureType for the AbstractProcedureItem.

Parameters:

item - AbstractProcedureItem.

envBridge - EnvironmentBridge.

Returns:

ProcedureType.

Throws:

java.lang.Exception - If fails to load the ProcedureType.

createItem

protected abstract I createItem()

Creates the AbstractProcedureItem implementation.

Returns:

AbstractProcedureItem implementation.

getSectionName

protected abstract java.lang.String getSectionName(M model)

Obtains the SubSection / OfficeSection name.

Parameters:

model - Model.

Returns:

SubSection / OfficeSection name.

getResource

protected abstract java.lang.String getResource(M model)

Obtains the resource.

Parameters:

model - Model.

Returns:

Resource.

getSourceName

protected abstract java.lang.String getSourceName(M model)

Obtains the source name.

Parameters:

model - Model.

Returns:

Source name.

getProcedureName

protected abstract java.lang.String getProcedureName(M model)

Obtains the Procedure name.

Parameters:

model - Model.

Returns:

Procedure name.

getProcedureProperties

protected abstract PropertyList getProcedureProperties(M model)

Obtains the Procedure PropertyList.

Parameters:

model - Model.

Returns:

Procedure PropertyList.

getInputConnectionClasses

protected abstract java.lang.Class<? extends ConnectionModel>[] getInputConnectionClasses()

Obtains the input ConnectionModel Class instances.

Returns:

Input ConnectionModel Class instances.

createNextItem

protected abstract AbstractItem<R,O,M,E,?,?> createNextItem()

Creates the Procedure next AbstractItem implementation.

Returns:

Procedure next AbstractItem implementation.

createOutputItem

protected abstract AbstractItem<R,O,M,E,?,?> createOutputItem()

Creates the Procedure output AbstractItem implementation.

Returns:

Procedure output AbstractItem implementation.

addProcedure

protected abstract Change<M> addProcedure(O operations,
                                          java.lang.String name,
                                          java.lang.String resource,
                                          java.lang.String sourceName,
                                          java.lang.String procedure,
                                          PropertyList properties,
                                          ProcedureType procedureType)

Creates Change to add Procedure.

Parameters:

operations - Operations.

name - SubSection / OfficeSection name.

resource - Resource.

sourceName - Source name.

procedure - Procedure name.

properties - PropertyList.

procedureType - ProcedureType.

Returns:

Change to add Procedure.

refactorProcedure

protected abstract Change<M> refactorProcedure(O operations,
                                               M model,
                                               java.lang.String name,
                                               java.lang.String resource,
                                               java.lang.String sourceName,
                                               java.lang.String procedure,
                                               PropertyList properties,
                                               ProcedureType procedureType,
                                               java.util.Map<java.lang.String,java.lang.String> outputNameMapping)

Creates Change to refactor Procedure.

Parameters:

operations - Operations.

model - Model to refactor.

name - SubSection / OfficeSection name.

resource - Resource.

sourceName - Source name.

procedure - Procedure name.

properties - PropertyList.

procedureType - ProcedureType.

outputNameMapping - Procedure output name mapping.

Returns:

Change to refactor Procedure.

removeProcedure

protected abstract Change<M> removeProcedure(O operations,
                                             M model)

Creates Change to remove Procedure.

Parameters:

operations - Operations.

model - Model to remove.

Returns:

Change to remove Procedure.

visual

public javafx.scene.layout.Pane visual(M model,
                                       AdaptedChildVisualFactoryContext<M> context)

Description copied from class: AbstractItem

Creates the visual for the Model.

Specified by:

visual in class AbstractItem<R extends Model,O,R extends Model,RE extends java.lang.Enum<RE>,M extends Model,E extends java.lang.Enum<E>>

Parameters:

model - Model.

context - AdaptedChildVisualFactoryContext.

Returns:

Node for the visual.

loadStyles

protected void loadStyles(java.util.List<AbstractItem.IdeStyle> styles)

Description copied from class: AbstractItem

Default implementation of AbstractItem.style() will invoke this to load styles.

Overrides:

loadStyles in class AbstractItem<R extends Model,O,R extends Model,RE extends java.lang.Enum<RE>,M extends Model,E extends java.lang.Enum<E>>

Parameters:

styles - List to be loaded with the AbstractItem.IdeStyle instances.

item

public I item(M model)

Description copied from class: AbstractConfigurableItem

Creates an item from the Model.

Specified by:

item in class AbstractConfigurableItem<R extends Model,RE extends java.lang.Enum<RE>,O,M extends Model,E extends java.lang.Enum<E>,I extends AbstractProcedureItem<R,RE,O,M,E,I>>

Parameters:

model - Model. May be null if create a Model.

Returns:

Item.

children

protected void children(java.util.List<AbstractItem.IdeChildrenGroup> childGroups)

Description copied from class: AbstractItem

Loads the AbstractItem.IdeChildrenGroup instances.

Overrides:

children in class AbstractItem<R extends Model,O,R extends Model,RE extends java.lang.Enum<RE>,M extends Model,E extends java.lang.Enum<E>>

Parameters:

childGroups - AbstractItem.IdeChildrenGroup instances.

configure

public AbstractConfigurableItem.IdeConfigurer configure()

Description copied from class: AbstractConfigurableItem

Obtains the item configuration.

Specified by:

configure in class AbstractConfigurableItem<R extends Model,RE extends java.lang.Enum<RE>,O,M extends Model,E extends java.lang.Enum<E>,I extends AbstractProcedureItem<R,RE,O,M,E,I>>

Returns:

AbstractConfigurableItem.IdeConfigurer for the item configuration.