org.eclipse.wst.common.frameworks.datamodel
Class AbstractDataModelProvider

java.lang.Object
  extended by org.eclipse.wst.common.frameworks.datamodel.AbstractDataModelProvider
All Implemented Interfaces:
IDataModelProperties, IDataModelProvider

public abstract class AbstractDataModelProvider
extends java.lang.Object
implements IDataModelProvider

A default implementation of IDataModelProvider.

Since:
1.0
See Also:
IDataModelProvider

Field Summary
 
Fields inherited from interface org.eclipse.wst.common.frameworks.datamodel.IDataModelProvider
OK_STATUS
 
Fields inherited from interface org.eclipse.wst.common.frameworks.datamodel.IDataModelProperties
ALLOW_EXTENSIONS, RESTRICT_EXTENSIONS
 
Constructor Summary
AbstractDataModelProvider()
           
 
Method Summary
 void dispose()
           A default implemenation of dispose().
 IDataModel getDataModel()
           An implemenation of getDataModel().
 IDataModelOperation getDefaultOperation()
           A default implemenation of getDefaultOperation().
 java.lang.Object getDefaultProperty(java.lang.String propertyName)
           A default implemenation of getDefaultProperty().
 java.util.List getExtendedContext()
           A default implemenation of getExtendedContext().
 java.lang.String getID()
           A default implemenation of getName().
 DataModelPropertyDescriptor getPropertyDescriptor(java.lang.String propertyName)
           A default implemenation of getPropertyDescriptor().
 java.util.Set getPropertyNames()
           Returns a list of property names for which this provider is responsible.
 DataModelPropertyDescriptor[] getValidPropertyDescriptors(java.lang.String propertyName)
           A default implemenation of getValidPropertyDescriptors().
 void init()
           A default implementation of init().
 boolean isPropertyEnabled(java.lang.String propertyName)
           A default implemenation of isPropertyEnabled().
 boolean propertySet(java.lang.String propertyName, java.lang.Object propertyValue)
           A default impleneation of propertySet().
 void setDataModel(IDataModel dataModel)
           An implemenation of setDataModel().
 org.eclipse.core.runtime.IStatus validate(java.lang.String name)
           A default implemenation of validate().
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractDataModelProvider

public AbstractDataModelProvider()
Method Detail

getPropertyNames

public java.util.Set getPropertyNames()
Description copied from interface: IDataModelProvider

Returns a list of property names for which this provider is responsible. This method is called only once during initialization.

Specified by:
getPropertyNames in interface IDataModelProvider
Returns:
the array of valid property names.

init

public void init()

A default implementation of init(). Subclasses should override as necessary.

Specified by:
init in interface IDataModelProvider
See Also:
IDataModelProvider.init()

setDataModel

public final void setDataModel(IDataModel dataModel)

An implemenation of setDataModel().

Specified by:
setDataModel in interface IDataModelProvider
See Also:
IDataModelProvider.setDataModel(IDataModel)

getDataModel

public final IDataModel getDataModel()

An implemenation of getDataModel().

Specified by:
getDataModel in interface IDataModelProvider
Returns:
the backing IDataModel
See Also:
IDataModelProvider.getDataModel()

propertySet

public boolean propertySet(java.lang.String propertyName,
                           java.lang.Object propertyValue)

A default impleneation of propertySet(). Subclasses should override as necessary.

Specified by:
propertySet in interface IDataModelProvider
Parameters:
propertyName - the name of the property that has been set
propertyValue - the value the property has been set
Returns:
true to fire a VALUE_CHG DataModelEvent.
See Also:
IDataModelProvider.propertySet(String, Object)

getDefaultProperty

public java.lang.Object getDefaultProperty(java.lang.String propertyName)

A default implemenation of getDefaultProperty(). Subclasses should override as necessary.

Specified by:
getDefaultProperty in interface IDataModelProvider
Parameters:
propertyName - the specified property
Returns:
the default property value
See Also:
IDataModelProvider.getDefaultProperty(String)

isPropertyEnabled

public boolean isPropertyEnabled(java.lang.String propertyName)

A default implemenation of isPropertyEnabled(). Subclasses should override as necessary.

Specified by:
isPropertyEnabled in interface IDataModelProvider
Parameters:
propertyName - the specified property
Returns:
true if the property is enabled, false otherwise.
See Also:
IDataModelProvider.isPropertyEnabled(String)

validate

public org.eclipse.core.runtime.IStatus validate(java.lang.String name)

A default implemenation of validate(). Subclasses should override as necessary.

Specified by:
validate in interface IDataModelProvider
Parameters:
name - the name of the property or nested IDataModel being validated.
Returns:
an IStatus
See Also:
IDataModelProvider.validate(String)

getPropertyDescriptor

public DataModelPropertyDescriptor getPropertyDescriptor(java.lang.String propertyName)

A default implemenation of getPropertyDescriptor(). Subclasses should override as necessary.

Specified by:
getPropertyDescriptor in interface IDataModelProvider
Parameters:
propertyName - the specified property
See Also:
IDataModelProvider.getPropertyDescriptor(String)

getValidPropertyDescriptors

public DataModelPropertyDescriptor[] getValidPropertyDescriptors(java.lang.String propertyName)

A default implemenation of getValidPropertyDescriptors(). Subclasses should override as necessary.

Specified by:
getValidPropertyDescriptors in interface IDataModelProvider
Parameters:
propertyName - the specified property
See Also:
IDataModelProvider.getValidPropertyDescriptors(String)

getExtendedContext

public java.util.List getExtendedContext()

A default implemenation of getExtendedContext(). Subclasses should override as necessary.

Specified by:
getExtendedContext in interface IDataModelProvider
See Also:
IDataModelProvider.getExtendedContext()

getDefaultOperation

public IDataModelOperation getDefaultOperation()

A default implemenation of getDefaultOperation(). Subclasses should override as necessary.

Specified by:
getDefaultOperation in interface IDataModelProvider
See Also:
IDataModelProvider.getDefaultOperation()

getID

public java.lang.String getID()

A default implemenation of getName(). Subclasses should override as necessary.

Specified by:
getID in interface IDataModelProvider
See Also:
IDataModelProvider.getID()

dispose

public void dispose()

A default implemenation of dispose(). Subclasses should override as necessary.

Specified by:
dispose in interface IDataModelProvider
See Also:
IDataModelProvider.dispose()