org.eclipse.datatools.connectivity.drivers.models
Class OverrideTemplateDescriptor

java.lang.Object
  extended by org.eclipse.datatools.connectivity.drivers.models.OverrideTemplateDescriptor
All Implemented Interfaces:
java.lang.Comparable

public class OverrideTemplateDescriptor
extends java.lang.Object
implements java.lang.Comparable

Represents a driver template override which is provided by the "org.eclipse.datatools.connectivity.driverExtension" extension point.

Author:
brianf

Field Summary
static java.lang.String PLUGIN_LOC
           
static java.lang.String TEMPLATE_TAG
           
 
Method Summary
 int compareTo(java.lang.Object o)
           
 boolean equals(java.lang.Object obj)
           
static OverrideTemplateDescriptor[] getByDriverTemplate(java.lang.String driverTemplateId)
           
 java.lang.String getCreateDefaultFlag()
          Returns the 'create default' flag value.
 java.lang.String getDefaultDefinitionName()
          Returns the default definition name.
 java.lang.String getDescription()
          Returns the description.
 IConfigurationElement getElement()
          Returns the configuration element.
 java.lang.String getEmptyJarListIsOKFlag()
          Returns the 'create default' flag value.
 java.lang.String getId()
           
 java.lang.String getJarList()
          Returns the file list
 java.lang.String getName()
          Returns the template name.
static OverrideTemplateDescriptor[] getOverrideDriverTemplateDescriptors()
          Returns all contributed driver templates.
 IConfigurationElement[] getOverrideProperties()
          Returns the list of configuration elements for the template properties.
 java.lang.String getParentCategory()
          Returns the parent category id.
 int getPriority()
          Returns the template id.
 java.lang.String getPropertyCategoryFromId(java.lang.String propId)
           
 java.lang.String getPropertyCustomPropDescriptorFromId(java.lang.String propId)
           
 java.lang.String getPropertyDescriptionFromId(java.lang.String propId)
           
 java.lang.String getPropertyExampleFromId(java.lang.String propId)
           
 java.lang.String getPropertyIDFromName(java.lang.String propName)
           
 java.lang.String getPropertyNameFromConfigElement(IConfigurationElement element)
           
 java.lang.String getPropertyNameFromId(java.lang.String propId)
           
 boolean getPropertyRemoveFlagFromID(java.lang.String propId)
           
 java.lang.String getPropertyRequiredFromId(java.lang.String propId)
           
 java.lang.String getPropertyValueFromId(java.lang.String propId)
           
 java.lang.String getPropertyVisibleFromId(java.lang.String propId)
           
 java.lang.String getTargetId()
          Returns the template id.
 IDriverValuesProvider getValuesProviderClass()
          Returns the values provider class
 int hashCode()
           
 boolean hasVisibleProperties()
          Determine if the template has visible properties
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TEMPLATE_TAG

public static final java.lang.String TEMPLATE_TAG
See Also:
Constant Field Values

PLUGIN_LOC

public static final java.lang.String PLUGIN_LOC
See Also:
Constant Field Values
Method Detail

getByDriverTemplate

public static OverrideTemplateDescriptor[] getByDriverTemplate(java.lang.String driverTemplateId)

getOverrideDriverTemplateDescriptors

public static OverrideTemplateDescriptor[] getOverrideDriverTemplateDescriptors()
Returns all contributed driver templates.


getTargetId

public java.lang.String getTargetId()
Returns the template id.


getId

public java.lang.String getId()

getPriority

public int getPriority()
Returns the template id.


getParentCategory

public java.lang.String getParentCategory()
Returns the parent category id.


getJarList

public java.lang.String getJarList()
Returns the file list


getValuesProviderClass

public IDriverValuesProvider getValuesProviderClass()
Returns the values provider class


getCreateDefaultFlag

public java.lang.String getCreateDefaultFlag()
Returns the 'create default' flag value.


getEmptyJarListIsOKFlag

public java.lang.String getEmptyJarListIsOKFlag()
Returns the 'create default' flag value. Default = false


getElement

public IConfigurationElement getElement()
Returns the configuration element.


getName

public java.lang.String getName()
Returns the template name.


getDefaultDefinitionName

public java.lang.String getDefaultDefinitionName()
Returns the default definition name.


getOverrideProperties

public IConfigurationElement[] getOverrideProperties()
Returns the list of configuration elements for the template properties.


getPropertyValueFromId

public java.lang.String getPropertyValueFromId(java.lang.String propId)

getPropertyNameFromId

public java.lang.String getPropertyNameFromId(java.lang.String propId)

getPropertyIDFromName

public java.lang.String getPropertyIDFromName(java.lang.String propName)

getPropertyDescriptionFromId

public java.lang.String getPropertyDescriptionFromId(java.lang.String propId)

getPropertyVisibleFromId

public java.lang.String getPropertyVisibleFromId(java.lang.String propId)

getPropertyExampleFromId

public java.lang.String getPropertyExampleFromId(java.lang.String propId)

getPropertyRequiredFromId

public java.lang.String getPropertyRequiredFromId(java.lang.String propId)

getPropertyCustomPropDescriptorFromId

public java.lang.String getPropertyCustomPropDescriptorFromId(java.lang.String propId)

getPropertyCategoryFromId

public java.lang.String getPropertyCategoryFromId(java.lang.String propId)

getPropertyRemoveFlagFromID

public boolean getPropertyRemoveFlagFromID(java.lang.String propId)

getPropertyNameFromConfigElement

public java.lang.String getPropertyNameFromConfigElement(IConfigurationElement element)

getDescription

public java.lang.String getDescription()
Returns the description.

Returns:
the description or null if no description is provided

compareTo

public int compareTo(java.lang.Object o)
Specified by:
compareTo in interface java.lang.Comparable

hasVisibleProperties

public boolean hasVisibleProperties()
Determine if the template has visible properties

Returns:

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object


Copyright © 2006 -- 2008 Actuate, IBM Corporation, Sybase, Inc. and others. All rights reserved.