Class symantec.itools.db.beans.util.ObjectFinder
All Packages  Class Hierarchy  This Package  Previous  Next  Index
  Class symantec.itools.db.beans.util.ObjectFinder
Object
   |
   +----symantec.itools.db.beans.util.ObjectFinder
  -  public class ObjectFinder
  
-  extends Object
  
ObjectFinder is a class which provides functionality for finding
 database components in a Visual Cafe project.
  
  -  
	brlBeans
   -    
 -  
	conMgrs
   -    
 -  
	derivAdapterBeans
   -    
 -  
	queryNavs
   -    
 -  
	recordDefs
   -    
 -  
	scINIFile
   -    
 -  
	sqlStmts
   -    
 -  
	sqlrecordDefs
   -    
 -  
	validAdapterBeans
   -    
 -  
	vcafeEnv
   -    
 -  
	visualObjs
   -    
 -  
	visualProj
   -  
 
  
  -  
	symantec.itools.db.beans.util.ObjectFinder()
   -   Constructor
 
  
  -  
	findQueryNavVObjByAliasName(String)
   -   Find a QueryNavigator VisualObject by its alias name
 
  
 -  
	findVisualProperty(VisualProperty[], String)
   -    Method to find a visual property by its name from
  the array of bean's visual properties.
  
 -  
	getBRLAdapterBeans()
   -   Method to return a list of business rule objects that are present
 in the current project
 
  
 -  
	getBaseRecordDefintionClassNames()
   -    Function to return an array of the RecordDefintion class names
 
  
 -  
	getColumnNameForBRLBean(VisualObject)
   -   Method to get the column name for a given VisualObject.
  
 -  
	getColumnsForQueryNav(VisualObject)
   -   Method to return a list of columns for a specific queryNavigator
 
  
 -  
	getColumnsForRecordDef(RecordDefinition)
   -   Get columns from RecordDefinition object.
  
 -  
	getConectionManager(String)
   -    Function returns an instantiated ConnectionManager class
 
  
 -  
	getConectionManager(String, Boolean)
   -    Function returns an instantiated ConnectionManager class   
 
  
 -  
	getConectionManagers()
   -   Function returns a Vector of com.symantec.itools.vcafe.openapi.VisualObject
 which are instances of symantec.itools.db.beans.ConectionManager
 This Vector should contain ONLY ONE element
 
  
 -  
	getConectionManagersClassNames()
   -    Function to return an array of the ConnectionManager class names
  This array should contain ONLY ONE element
 
  
 -  
	getDataModelForQueryNav(VisualObject)
   -   Function to return the DataModel from a query navigator
 
  
 -  
	getDataModelForQueryNav(VisualObject, boolean)
   -   Function to return the DataModel from a query navigator
 
  
 -  
	getDatabindNameForBRLBean(VisualObject)
   -   Method to get the databinding name for a given VisualObject.
  
 -  
	getDatabindNameForSQLstatement(VisualObject)
   -   Method to get the databinding name for a given VisualObject.
  
 -  
	getDerivationAdapterBeans()
   -   Method to return a list of derived columns that are present in
 the current project
 
  
 -  
	getDesignTimeData(String, Integer)
   -   Function which returns design time data for a Query Navigator
 The Query Navigator is specified by its alias name
 
  
 -  
	getDesignTimeData(VisualObject, int)
   -   Function which returns design time data for a current Query Navigator     
 
  
 -  
	getDesignTimeSetting()
   -   Method to return the current design time setting based
 upon the setting in SC.INI
 
  
 -  
	getINIFile()
   -    
 -  
	getParameterMetaDataForSQLStatement(VisualObject)
   -   Method to get the ParameterMetaData[] for a given VisualObject.
  
 -  
	getParameterNamesForSQLstatement(VisualObject)
   -   Method to get the databinding name for a given VisualObject.
  
 -  
	getProjBuildStatus()
   -   Method to return project build status
 
  
 -  
	getQueryNavigators()
   -   Function returns a Vector of com.symantec.itools.vcafe.openapi.VisualObject
 which are instances of symantec.itools.db.beans.QueryNavigator
 
  
 -  
	getRecordDefForQueryNav(VisualObject)
   -   Return instantiated RecordDefinition object for query navigator
 
  
 -  
	getRecordDefVisualObjForQueryNav(VisualObject)
   -   Return visualobject for record defintion for a given query navigator
 
  
 -  
	getRecordDefintionClassNames()
   -   Function to return an array of the RecordDefintion class names
 
  
 -  
	getResultColumnsForSQLAdapter(VisualObject)
   -  
 Return result set columns for a SQLAdapter
 
  
 -  
	getSQLAdapterVisualObjForQueryNav(VisualObject)
   -   Return visualobject for SQLAdapter for a given query navigator
 
  
 -  
	getSQLRecordDefintionClassNames()
   -    Function to return an array of the RecordDefintion class names
 
  
 -  
	getSQLstatements()
   -   Function returns a Vector of com.symantec.itools.vcafe.openapi.VisualObject
 which are instances of symantec.itools.db.beans.SQLAdapter
 
  
 -  
	getValidationAdapterBeans()
   -   Method to return a list of validated columns that are present in
 the current project
 
  
 -  
	isDesignTimeDataNecessary()
   -   Method to determine if design time data should be obtained.
  
 -  
	isOffLineMode()
   -   Method to determine if the project is to be developed in offline mode
 
  
 -  
	setProjBuildStatus(boolean)
   -   Method to set the project built status
 
 
  
brlBeans
protected java.util.Vector brlBeans
conMgrs
protected java.util.Vector conMgrs
derivAdapterBeans
protected java.util.Vector derivAdapterBeans
queryNavs
protected java.util.Vector queryNavs
recordDefs
protected java.util.Vector recordDefs
scINIFile
protected symantec.itools.vcafe.inioptions.VisualCafeINI scINIFile
sqlStmts
protected java.util.Vector sqlStmts
sqlrecordDefs
protected java.util.Vector sqlrecordDefs
validAdapterBeans
protected java.util.Vector validAdapterBeans
vcafeEnv
protected com.symantec.itools.vcafe.openapi.VisualCafe vcafeEnv
visualObjs
protected com.symantec.itools.vcafe.openapi.VisualObject[] visualObjs
visualProj
protected com.symantec.itools.vcafe.openapi.VisualProject visualProj
  
ObjectFinder
public ObjectFinder()
  -  Constructor
  
 
 
  
findQueryNavVObjByAliasName
public com.symantec.itools.vcafe.openapi.VisualObject findQueryNavVObjByAliasName(String queryNavAliasName)
  -  Find a QueryNavigator VisualObject by its alias name
  
 
 
    -  Parameters:
    
 -  queryNavAliasName - is an alias name for a query Navigator
    
 -  Returns:
    
 -  a QueryNavigator VisualObject with the specified alias name
  
 
 
 
findVisualProperty
public static com.symantec.itools.vcafe.openapi.VisualProperty findVisualProperty(VisualProperty[] visualProps,
                                                                                  String propName)
  -  Method to find a visual property by its name from
  the array of bean's visual properties.
  
 
 
    -  Parameters:
    
 -  visualProps - is the array returned by
  com.symantec.itools.vcafe.openapi.VisualObject.getProperties() method
    
-  propName - is the property display name. If you are using
  java.beans.PropertyDescriptor.setDisplayName() in you BeanInfo
  then you should use the same value here for 
propName.
      -  Returns:
    
 -  The visual property named 
propName
   
 
 
getBRLAdapterBeans
public java.util.Vector getBRLAdapterBeans()
  -  Method to return a list of business rule objects that are present
 in the current project
  
 
 
    -  Returns:
    
 -  Vector of CompColAdapterBean VisualObjects
  
 
 
 
getBaseRecordDefintionClassNames
public java.lang.String[] getBaseRecordDefintionClassNames()
  -  Function to return an array of the RecordDefintion class names
  
 
 
    -  Returns:
    
 -  String array of RecordDefintion class names
  
 
 
 
getColumnNameForBRLBean
public java.lang.String getColumnNameForBRLBean(VisualObject vObj)
  -  Method to get the column name for a given VisualObject.
  
 
 
    -  Parameters:
    
 -  VisualObject - for CompColAdapterBean
    
 -  Returns:
    
 -  String
  
 
 
 
getColumnsForQueryNav
public java.lang.String[] getColumnsForQueryNav(VisualObject queryNav)
  -  Method to return a list of columns for a specific queryNavigator
  
 
 
    -  Parameters:
    
 -  VisualObject - for query Navigator
    
 -  Returns:
    
 -  String[] of columns for QueryNavigator
  
 
 
 
getColumnsForRecordDef
public java.lang.String[] getColumnsForRecordDef(RecordDefinition recordDef)
  -  Get columns from RecordDefinition object.
 Note: The column list returned is static.
  
 
 
    -  Parameters:
    
 -  RecordDefinition - object
    
 -  Returns:
    
 -  String array of columns
  
 
 
 
getConectionManager
public symantec.itools.db.beans.jdbc.ConnectionManager getConectionManager(String connMgrClassName)
  -  Function returns an instantiated ConnectionManager class
  
 
 
    -  Returns:
    
 -  ConnectionManager
  
 
 
 
getConectionManager
public symantec.itools.db.beans.jdbc.ConnectionManager getConectionManager(String connMgrClassName,
                                                                           Boolean BuildFlag)
  -  Function returns an instantiated ConnectionManager class
  
 
 
    -  Parameters:
    
 -  connMgrClassName - is the name of the class that will be instantiated
    
 -  Returns:
    
 -  ConnectionManager
  
 
 
 
getConectionManagers
public java.util.Vector getConectionManagers()
  -  Function returns a Vector of com.symantec.itools.vcafe.openapi.VisualObject
 which are instances of symantec.itools.db.beans.ConectionManager
 This Vector should contain ONLY ONE element
  
 
 
    -  Returns:
    
 -  Vector of VisualObjects for ConnectionManager
  
 
 
 
getConectionManagersClassNames
public java.lang.String[] getConectionManagersClassNames()
  -  Function to return an array of the ConnectionManager class names
  This array should contain ONLY ONE element
  
 
 
    -  Returns:
    
 -  String array of Connection Manager class names
  
 
 
 
getDataModelForQueryNav
public symantec.itools.db.beans.jdbc.DataModel getDataModelForQueryNav(VisualObject queryNav)
  -  Function to return the DataModel from a query navigator
  
 
 
    -  Parameters:
    
 -  - - VisualObject for QueryNavigator
    
 -  Returns:
    
 -  - DataModel containing design time information
  
 
 
 
getDataModelForQueryNav
public symantec.itools.db.beans.jdbc.DataModel getDataModelForQueryNav(VisualObject queryNav,
                                                                       boolean specialFeatures)
  -  Function to return the DataModel from a query navigator
  
 
 
    -  Parameters:
    
 -  - - VisualObject for QueryNavigator
    
-  - - boolean indicating true or false
    
  -  Returns:
    
 -  - DataModel containing design time information
  
 
 
 
getDatabindNameForBRLBean
public java.lang.String getDatabindNameForBRLBean(VisualObject vObj)
  -  Method to get the databinding name for a given VisualObject.
  
 
 
    -  Parameters:
    
 -  VisualObject - for CompColAdapterBean
    
 -  Returns:
    
 -  String
  
 
 
 
getDatabindNameForSQLstatement
public java.lang.String getDatabindNameForSQLstatement(VisualObject vObj)
  -  Method to get the databinding name for a given VisualObject.
  
 
 
    -  Parameters:
    
 -  VisualObject - for SQLstatement
    
 -  Returns:
    
 -  String
  
 
 
 
getDerivationAdapterBeans
public java.util.Vector getDerivationAdapterBeans()
  -  Method to return a list of derived columns that are present in
 the current project
  
 
 
    -  Returns:
    
 -  Vector of CalculationAdapter VisualObjects
  
 
 
 
getDesignTimeData
public java.util.Hashtable getDesignTimeData(String queryNavAliasName,
                                             Integer designTimeRows)
  -  Function which returns design time data for a Query Navigator
 The Query Navigator is specified by its alias name
  
 
 
    -  Parameters:
    
 -  queryNavAliasName - is an alias name for a query Navigator
    
-  int - for number of rows requested
    
  -  Returns:
    
 -  vector of hash table
  
 
 
 
getDesignTimeData
public java.util.Hashtable getDesignTimeData(VisualObject queryNavVObj,
                                             int designTimeRows)
  -  Function which returns design time data for a current Query Navigator
  
 
 
    -  Parameters:
    
 -  VisualObject - for query Navigator
    
-  int - for number of rows requested
    
  -  Returns:
    
 -  vector of hash table
  
 
 
 
getDesignTimeSetting
public int getDesignTimeSetting()
  -  Method to return the current design time setting based
 upon the setting in SC.INI
  
 
 
    -  Returns:
    
 -  integer value
  
 
 
 
getINIFile
protected symantec.itools.vcafe.inioptions.VisualCafeINI getINIFile()
getParameterMetaDataForSQLStatement
public symantec.itools.db.beans.jdbc.ParameterMetaData[] getParameterMetaDataForSQLStatement(VisualObject vObj)
  -  Method to get the ParameterMetaData[] for a given VisualObject.
  
 
 
    -  Parameters:
    
 -  VisualObject - for SQLStatement
    
 -  Returns:
    
 -  ParameterMetaData[]
  
 
 
 
getParameterNamesForSQLstatement
public java.lang.String[] getParameterNamesForSQLstatement(VisualObject vObj)
  -  Method to get the databinding name for a given VisualObject.
  
 
 
    -  Parameters:
    
 -  VisualObject - for SQLstatement
    
 -  Returns:
    
 -  String[] with the names of all parameters
  
 
 
 
getProjBuildStatus
public static boolean getProjBuildStatus()
  -  Method to return project build status
  
 
 
    -  Returns:
    
 -  true or false
  
 
 
 
getQueryNavigators
public java.util.Vector getQueryNavigators()
  -  Function returns a Vector of com.symantec.itools.vcafe.openapi.VisualObject
 which are instances of symantec.itools.db.beans.QueryNavigator
  
 
 
    -  Returns:
    
 -  Vector of QueryNavigator VisualObjects
  
 
 
 
getRecordDefForQueryNav
public symantec.itools.db.beans.jdbc.RecordDefinition getRecordDefForQueryNav(VisualObject queryNav)
  -  Return instantiated RecordDefinition object for query navigator
  
 
 
    -  Parameters:
    
 -  VisualObject - - query Navigator
    
 -  Returns:
    
 -  RecordDefinition
  
 
 
 
getRecordDefVisualObjForQueryNav
public com.symantec.itools.vcafe.openapi.VisualObject getRecordDefVisualObjForQueryNav(VisualObject queryNav)
  -  Return visualobject for record defintion for a given query navigator
  
 
 
    -  Parameters:
    
 -  VisualObject - for query navigator
    
 -  Returns:
    
 -  VisualObject for record definition
  
 
 
 
getRecordDefintionClassNames
public java.lang.String[] getRecordDefintionClassNames()
  -  Function to return an array of the RecordDefintion class names
  
 
 
    -  Returns:
    
 -  String array of RecordDefintion class names
  
 
 
 
getResultColumnsForSQLAdapter
public java.lang.String[] getResultColumnsForSQLAdapter(VisualObject SQLAdapterVObj)
  -  Return result set columns for a SQLAdapter
  
 
 
    -  Parameters:
    
 -  VisualObject - for SQLAdapter
    
 -  Returns:
    
 -  resultset column names in a string array
  
 
 
 
getSQLAdapterVisualObjForQueryNav
public com.symantec.itools.vcafe.openapi.VisualObject getSQLAdapterVisualObjForQueryNav(VisualObject queryNav)
  -  Return visualobject for SQLAdapter for a given query navigator
  
 
 
    -  Parameters:
    
 -  VisualObject - for query navigator
    
 -  Returns:
    
 -  VisualObject for SQLAdapter
  
 
 
 
getSQLRecordDefintionClassNames
public java.lang.String[] getSQLRecordDefintionClassNames()
  -  Function to return an array of the RecordDefintion class names
  
 
 
    -  Returns:
    
 -  String array of RecordDefintion class names
  
 
 
 
getSQLstatements
public java.util.Vector getSQLstatements()
  -  Function returns a Vector of com.symantec.itools.vcafe.openapi.VisualObject
 which are instances of symantec.itools.db.beans.SQLAdapter
  
 
 
    -  Returns:
    
 -  Vector for SQL Statements [ie] Stored Procedures/SQL Beans
  
 
 
 
getValidationAdapterBeans
public java.util.Vector getValidationAdapterBeans()
  -  Method to return a list of validated columns that are present in
 the current project
  
 
 
    -  Returns:
    
 -  Vector of ValidationAdapter VisualObjects
  
 
 
 
isDesignTimeDataNecessary
public boolean isDesignTimeDataNecessary()
  -  Method to determine if design time data should be obtained.
 Read the SC.INI and check for DB_DESIGN_DATA entry.
 If the value is LIVE_DATA_OFF, then always return false.
 If the value is LIVE_DATA_COLUMN or LIVE_DATA_ON, check
 the backrun status. 
      If backrunner is running, return false
      else return true.
  
 
 
    -  Returns:
    
 -  true or false
  
 
 
 
isOffLineMode
public boolean isOffLineMode()
  -  Method to determine if the project is to be developed in offline mode
  
 
 
    -  Returns:
    
 -  true or false
  
 
 
 
setProjBuildStatus
public static void setProjBuildStatus(boolean val)
  -  Method to set the project built status
  
 
 
    -  Parameters:
    
 -  true - or false indicating project built status
  
 
 
 
All Packages  Class Hierarchy  This Package  Previous  Next  Index