Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.function.extension.impl
Class AbstractFunctionWizardDescriptor<T extends AbstractFunction<?>>

java.lang.Object
  extended by de.cs3d.util.eclipse.extension.AbstractObjectDefinition
      extended by de.cs3d.util.eclipse.extension.AbstractObjectFactory<T>
          extended by de.cs3d.util.eclipse.extension.AbstractConfigurationFactory<FunctionWizardFactory>
              extended by eu.esdihumboldt.hale.ui.function.extension.impl.AbstractFunctionWizardDescriptor<T>
Type Parameters:
T - the function definition type
All Implemented Interfaces:
de.cs3d.util.eclipse.extension.ExtensionObjectDefinition, de.cs3d.util.eclipse.extension.ExtensionObjectFactory<FunctionWizardFactory>, de.cs3d.util.eclipse.extension.Prioritizable, FunctionWizardDescriptor<T>, FunctionWizardFactory, Comparable<de.cs3d.util.eclipse.extension.ExtensionObjectDefinition>
Direct Known Subclasses:
PropertyFunctionWizardDescriptorImpl, TypeFunctionWizardDescriptorImpl

public abstract class AbstractFunctionWizardDescriptor<T extends AbstractFunction<?>>
extends de.cs3d.util.eclipse.extension.AbstractConfigurationFactory<FunctionWizardFactory>
implements FunctionWizardDescriptor<T>

Abstract function wizard descriptor based on a configuration element

Author:
Simon Templer

Field Summary
 
Fields inherited from class de.cs3d.util.eclipse.extension.AbstractConfigurationFactory
conf
 
Constructor Summary
protected AbstractFunctionWizardDescriptor(org.eclipse.core.runtime.IConfigurationElement conf)
          Create a function wizard descriptor based on the given configuration element
 
Method Summary
protected abstract  FunctionWizardFactory createDefaultFactory()
          Create the default function wizard factory for the function if none is explicitly defined or its creation fails.
 FunctionWizard createEditWizard(Cell cell)
          Creates a wizard for editing an existing cell.
 FunctionWizardFactory createExtensionObject()
           
 FunctionWizard createNewWizard(SchemaSelection schemaSelection)
          Creates a wizard for creating a new cell based on the given schema selection.
 void dispose(FunctionWizardFactory instance)
           
 String getDisplayName()
           
protected  FunctionWizardFactory getFactory()
          Get the associated function wizard factory
 String getFunctionId()
          Get the ID of the associated function
 URL getIconURL()
           
 String getIdentifier()
           
 
Methods inherited from class de.cs3d.util.eclipse.extension.AbstractConfigurationFactory
getIconURL, getTypeName
 
Methods inherited from class de.cs3d.util.eclipse.extension.AbstractObjectFactory
allowConfigure, configure
 
Methods inherited from class de.cs3d.util.eclipse.extension.AbstractObjectDefinition
compareTo, equals, getPriority, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface eu.esdihumboldt.hale.ui.function.extension.FunctionWizardDescriptor
getFunction
 
Methods inherited from interface de.cs3d.util.eclipse.extension.ExtensionObjectFactory
allowConfigure, configure
 
Methods inherited from interface de.cs3d.util.eclipse.extension.ExtensionObjectDefinition
getTypeName
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Constructor Detail

AbstractFunctionWizardDescriptor

protected AbstractFunctionWizardDescriptor(org.eclipse.core.runtime.IConfigurationElement conf)
Create a function wizard descriptor based on the given configuration element

Parameters:
conf - the configuration element
Method Detail

dispose

public void dispose(FunctionWizardFactory instance)
Specified by:
dispose in interface de.cs3d.util.eclipse.extension.ExtensionObjectFactory<FunctionWizardFactory>
See Also:
ExtensionObjectFactory.dispose(Object)

getIdentifier

public String getIdentifier()
Specified by:
getIdentifier in interface de.cs3d.util.eclipse.extension.ExtensionObjectDefinition
See Also:
ExtensionObjectDefinition.getIdentifier()

getDisplayName

public String getDisplayName()
Specified by:
getDisplayName in interface de.cs3d.util.eclipse.extension.ExtensionObjectDefinition
See Also:
ExtensionObjectDefinition.getDisplayName()

getFunctionId

public String getFunctionId()
Description copied from interface: FunctionWizardDescriptor
Get the ID of the associated function

Specified by:
getFunctionId in interface FunctionWizardDescriptor<T extends AbstractFunction<?>>
Returns:
the function ID
See Also:
FunctionWizardDescriptor.getFunctionId()

getIconURL

public URL getIconURL()
Specified by:
getIconURL in interface de.cs3d.util.eclipse.extension.ExtensionObjectDefinition
Overrides:
getIconURL in class de.cs3d.util.eclipse.extension.AbstractObjectFactory<FunctionWizardFactory>
See Also:
AbstractObjectFactory.getIconURL()

createExtensionObject

public FunctionWizardFactory createExtensionObject()
                                            throws Exception
Specified by:
createExtensionObject in interface de.cs3d.util.eclipse.extension.ExtensionObjectFactory<FunctionWizardFactory>
Overrides:
createExtensionObject in class de.cs3d.util.eclipse.extension.AbstractConfigurationFactory<FunctionWizardFactory>
Throws:
Exception
See Also:
AbstractConfigurationFactory.createExtensionObject()

createDefaultFactory

protected abstract FunctionWizardFactory createDefaultFactory()
Create the default function wizard factory for the function if none is explicitly defined or its creation fails.

Returns:
the default function wizard factory

getFactory

protected FunctionWizardFactory getFactory()
Get the associated function wizard factory

Returns:
the function wizard factory

createNewWizard

public FunctionWizard createNewWizard(SchemaSelection schemaSelection)
Description copied from interface: FunctionWizardFactory
Creates a wizard for creating a new cell based on the given schema selection.

Specified by:
createNewWizard in interface FunctionWizardFactory
Parameters:
schemaSelection - the schema selection or null if no pre-selection is available
Returns:
the new wizard instance
See Also:
FunctionWizardFactory.createNewWizard(SchemaSelection)

createEditWizard

public FunctionWizard createEditWizard(Cell cell)
Description copied from interface: FunctionWizardFactory
Creates a wizard for editing an existing cell.

Specified by:
createEditWizard in interface FunctionWizardFactory
Parameters:
cell - the cell to edit
Returns:
the new wizard instance
See Also:
FunctionWizardFactory.createEditWizard(Cell)

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d