| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.datatools.connectivity.sqm.loader.JDBCBaseLoader
org.eclipse.datatools.connectivity.sqm.loader.JDBCRoutineLoader
public class JDBCRoutineLoader
Base loader implementation for loading a database's routine (SP, UDF) objects. This class may be specialized as necessary to meet a particular vendor's needs.
| Nested Class Summary | |
|---|---|
| static interface | JDBCRoutineLoader.IRoutineFactoryInterface for providing creation logic for routines. | 
| static class | JDBCRoutineLoader.ProcedureFactoryBase factory implementation for SP. | 
| static class | JDBCRoutineLoader.UserDefinedFunctionFactoryBase factory implementation for UDF. | 
| Field Summary | |
|---|---|
| static java.lang.String | COLUMN_PROCEDURE_NAMEThe column name containing the routine's name. | 
| static java.lang.String | COLUMN_PROCEDURE_TYPEThe column name containing the routine's type (SP/UDF). | 
| static java.lang.String | COLUMN_REMARKSThe column name containing the routine's description. | 
| Constructor Summary | |
|---|---|
| JDBCRoutineLoader(ICatalogObject catalogObject)This constructs the loader using the default ProcedureFactory and UserDefinedFunctionFactory and uses the ConnectionFilter.STORED_PROCEDURE_FILTER filter. | |
| JDBCRoutineLoader(ICatalogObject catalogObject,
                  IConnectionFilterProvider connectionFilterProvider)This constructs the loader using the default ProcedureFactory and UserDefinedFunctionFactory. | |
| JDBCRoutineLoader(ICatalogObject catalogObject,
                  IConnectionFilterProvider connectionFilterProvider,
                  JDBCRoutineLoader.IRoutineFactory udfFactory,
                  JDBCRoutineLoader.IRoutineFactory spFactory) | |
| Method Summary | |
|---|---|
|  void | clearRoutines(java.util.List routines)Removes the specified routines from the model. | 
|  JDBCRoutineLoader.IRoutineFactory | getProcedureFactory() | 
|  JDBCRoutineLoader.IRoutineFactory | getUserDefinedFunctionFactory()Sets the UDF factory used by this object | 
|  java.util.List | loadRoutines()Deprecated. see loadRoutines(List, Collection) | 
|  void | loadRoutines(java.util.List containmentList,
             java.util.Collection existingRoutines)Loads the "routine" objects from the database. | 
|  void | setProcedureFactory(JDBCRoutineLoader.IRoutineFactory procedureFactory)Sets the procedure factory used by this object | 
|  void | setUserDefinedFunctionFactory(JDBCRoutineLoader.IRoutineFactory userDefinedFunctionFactory) | 
| Methods inherited from class org.eclipse.datatools.connectivity.sqm.loader.JDBCBaseLoader | 
|---|
| getCatalogObject, setCatalogObject | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
public static final java.lang.String COLUMN_PROCEDURE_NAME
java.sql.DatabaseMetaData.getProcedures(), 
Constant Field Valuespublic static final java.lang.String COLUMN_REMARKS
java.sql.DatabaseMetaData.getProcedures(), 
Constant Field Valuespublic static final java.lang.String COLUMN_PROCEDURE_TYPE
java.sql.DatabaseMetaData.getProcedures(), 
Constant Field Values| Constructor Detail | 
|---|
public JDBCRoutineLoader(ICatalogObject catalogObject)
catalogObject - the Schema object upon which this loader operates.
public JDBCRoutineLoader(ICatalogObject catalogObject,
                         IConnectionFilterProvider connectionFilterProvider)
catalogObject - the Schema object upon which this loader operates.connectionFilterProvider - the filter provider used for filtering
        the "routine" objects being loaded
public JDBCRoutineLoader(ICatalogObject catalogObject,
                         IConnectionFilterProvider connectionFilterProvider,
                         JDBCRoutineLoader.IRoutineFactory udfFactory,
                         JDBCRoutineLoader.IRoutineFactory spFactory)
catalogObject - the Schema object upon which this loader operates.connectionFilterProvider - the filter provider used for filtering
        the "routine" objects being loadedudfFactory - factory for creating UDF objectsspFactory - factory for creating SP objects| Method Detail | 
|---|
public java.util.List loadRoutines()
                            throws java.sql.SQLException
loadRoutines(List, Collection)
java.sql.SQLException - if an error occurred during loading.
public void loadRoutines(java.util.List containmentList,
                         java.util.Collection existingRoutines)
                  throws java.sql.SQLException
containmentList - the containment list held by parentexistingRoutines - the catalog objects which were previously loaded
java.sql.SQLException - if an error occurred during loading.public void clearRoutines(java.util.List routines)
routines - the routines to be removed from the model.public JDBCRoutineLoader.IRoutineFactory getProcedureFactory()
public void setProcedureFactory(JDBCRoutineLoader.IRoutineFactory procedureFactory)
public JDBCRoutineLoader.IRoutineFactory getUserDefinedFunctionFactory()
public void setUserDefinedFunctionFactory(JDBCRoutineLoader.IRoutineFactory userDefinedFunctionFactory)
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||