/src/edu/ucsb/nceas/metacat/scheduler/ScheduledJobAccess.java - Diff - Metacat - Ecoinformatics Redmine

« Previous | Next »

Revision 4971

Added by daigle almost 15 years ago

Beef up comments

     	private Logger logMetacat = Logger.getLogger(ScheduledJobAccess.class);
     	// Constructor
     	public ScheduledJobAccess() throws AccessException {
     		super("ScheduledJobAccess");
+    	}
     	/**
     	 * Get a job based on it's id
+    	 *
     	 * @param jobId
     	 *            the id of the job in the database
     	 * @return the scheduled job data object that represents the desired job
     	 */
     	public ScheduledJobDAO getJob(Long jobId) throws AccessException {
     		ScheduledJobDAO jobDAO = null;
     		// first get the job from the db and put it into a DAO
     		PreparedStatement pstmt = null;
     		try {
     			String sql = "SELECT * FROM scheduled_job WHERE id = ? AND status != 'deleted'";
-...
+    			}
+    		}
     		// Now get all the job parameters and put those into a list of job parameter
     		// DAOs and add that list to the job DAO
     		ScheduledJobParamAccess jobParamAccess = new ScheduledJobParamAccess();
     		Vector<ScheduledJobParamDAO> jobParamList =
     			jobParamAccess.getJobParamsForJobId(jobDAO.getId());
-...
     		return jobDAO;
+    	}
     	/**
     	 * Get a job by it's name
     	 * @param jobName the name of the job to get
     	 * @return the scheduled job data object that represents the desired job
     	 */
     	public ScheduledJobDAO getJobByName(String jobName) throws AccessException {
     		ScheduledJobDAO jobDAO = null;
     		// first get the job from the db and put it into a DAO
     		PreparedStatement pstmt = null;
     		try {
     			String sql = "SELECT * FROM scheduled_job WHERE name = ? AND status != 'deleted'";
-...
+    			}
+    		}
     		// Now get all the job parameters and put those into a list of job parameter
     		// DAOs and add that list to the job DAO
     		ScheduledJobParamAccess jobParamAccess = new ScheduledJobParamAccess();
     		Vector<ScheduledJobParamDAO> jobParamList =
     			jobParamAccess.getJobParamsForJobId(jobDAO.getId());
-...
     		return jobDAO;
+    	}
     	/**
     	 * Get all jobs that have a given parameter with a given value
+    	 *
     	 * @param groupName
     	 *            the group to which the job belongs. This keeps us from
     	 *            returning unrelated jobs that just happen to have a similar
     	 *            parameter
     	 * @param paramName
     	 *            the name of the parameter we are looking for
     	 * @param paramValue
     	 *            the value of the parameter we are looking for
     	 * @return a HashMap of job data objects with all jobs in a given group that
     	 *         have parameters that match our parameter.
     	 */
     	public HashMap<Long, ScheduledJobDAO> getJobsWithParameter(String groupName, String paramName, String paramValue) throws AccessException {
     		// first get all jobs
     		HashMap<Long, ScheduledJobDAO> allJobsMap = getAllJobs(groupName);
     		HashMap<Long, ScheduledJobDAO> jobsWithParamMap = new HashMap<Long, ScheduledJobDAO>();
     		// then iterate through and grab the ones that have the desired parameter
     		for (Long jobDAOId : allJobsMap.keySet()) {
     			ScheduledJobDAO jobDAO = allJobsMap.get(jobDAOId);
     			if (paramValue != null && paramName != null) {
-...
     		return jobsWithParamMap;
+    	}
     	/**
     	 * Get all jobs for a given group.  A group is typically a category that coincides with
     	 * the job type (has it's own job implementation).
     	 * @param groupName the name of the group we want to search
     	 * @return a HashMap of job data objects for the desired group.
     	 */
     	public HashMap<Long, ScheduledJobDAO> getAllJobs(String groupName) throws AccessException {
     		ScheduledJobDAO jobDAO = null;
     		HashMap<Long, ScheduledJobDAO> allJobDAOs = new HashMap<Long, ScheduledJobDAO>();
     		// Get all jobs where the status is not deleted
     		PreparedStatement pstmt = null;
     		try {
     			String sql = "SELECT * FROM scheduled_job WHERE status != 'deleted'";
-...
     				allJobDAOs.put(jobDAO.getId(), jobDAO);
+    			}
     			// Here we grab all job params and put them into the associated jobs.  THis
     			// takes a little stress off the database by avoiding a join.
     			ScheduledJobParamAccess jobParamAccess = new ScheduledJobParamAccess();
     			Vector<ScheduledJobParamDAO> jobParamList =
     				jobParamAccess.getAllJobParams();
-...
+    	}
     	/**
     	 * Create a job in the database.
+    	 *
     	 * @param name
     	 *            the name of the job. This should be unique
     	 * @param triggerName
     	 *            the name of the trigger that is registered in the scheduler
     	 *            service
     	 * @param groupName
     	 *            the group of the job
     	 * @param jobClass
     	 *            the class that implements the job functionality. The name of
     	 *            this class will be extracted and put into the database.
     	 * @param startTime
     	 *            the time when the job should first run
     	 * @param intervalValue
     	 *            the amount of time between job runs.
     	 * @param intervalUnit
     	 *            the unit of time that the intervalValue represents. Valid
     	 *            values are s,m,h, d and w
     	 * @param jobParams
     	 *            a map of parameters that are associated with this job.
     	 */
     	public void createJob(String name, String triggerName, String groupName,
     			Class<Job> jobClass, Calendar startTime, int intervalValue,
     			String intervalUnit, HashMap<String, String> jobParams)
     			throws AccessException {
     		// Create and populate a job data object
     		ScheduledJobDAO jobDAO = new ScheduledJobDAO();
     		jobDAO.setStatus(StatusUtil.SCHEDULED);
     		jobDAO.setName(name);
-...
     		createJob(jobDAO, jobParams);
+    	}
     	/**
     	 * Create a job in the database
     	 * @param jobDAO the job data object that holds necessary information
     	 * @param jobParams a map of parameters that are associated with this job.
     	 */
     	public void createJob(ScheduledJobDAO jobDAO, HashMap<String, String> jobParams) throws AccessException {
     		PreparedStatement pstmt = null;
     		// First insert the job
     		try {
     			String sql =
     				"INSERT INTO scheduled_job (date_created, date_updated, status, name, trigger_name, group_name, class_name, start_time, interval_value, interval_unit) "
-...
+    			}
+    		}
     		// Then iterate through the job params and insert them into the db
     		if (jobParams.size() > 0) {
     			ScheduledJobParamAccess scheduledJobParamsAccess = null;
     			ScheduledJobDAO updatedJobDAO = null;
-...
+    		}
+    	}
     	/**
     	 * Update the status of a job in the database
+    	 *
     	 * @param jobDAO
     	 *            the job data object that we want to change. The status should
     	 *            already have been updated in this object
     	 */
     	public void updateJobStatus(ScheduledJobDAO jobDAO) throws AccessException {
     		if (jobDAO == null) {
-...
+    	}
     	/**
     	 * Populate a job data object with the current row in a resultset
+    	 *
     	 * @param resultSet
     	 *            the result set which is already pointing to the desired row.
     	 * @return a scheduled job data object
     	 */
     	protected ScheduledJobDAO populateDAO(ResultSet resultSet) throws SQLException {
     		ScheduledJobDAO jobDAO = new ScheduledJobDAO();

Also available in: Unified diff

Project

General

Profile

Metacat

Revision 4971

Added by daigle almost 15 years ago