org.apache.oodt.cas.workflow.instrepo

Class LuceneWorkflowInstanceRepository

java.lang.Object

org.apache.oodt.cas.workflow.instrepo.AbstractPaginatibleInstanceRepository

org.apache.oodt.cas.workflow.instrepo.LuceneWorkflowInstanceRepository

All Implemented Interfaces:

WorkflowInstanceRepository, Pagination

public class LuceneWorkflowInstanceRepository
extends AbstractPaginatibleInstanceRepository

Version:

$Revision$

An implementation of the WorkflowEngine interface that is backed by Apache Lucene.

.

Author:

mattmann

Field Summary

Fields

Modifier and Type	Field and Description
static int	MERGE_FACTOR

Fields inherited from class org.apache.oodt.cas.workflow.instrepo.AbstractPaginatibleInstanceRepository

pageSize

Fields inherited from interface org.apache.oodt.cas.workflow.instrepo.WorkflowInstanceRepository

X_POINT_ID

Constructor Summary

Constructors

Constructor and Description
LuceneWorkflowInstanceRepository(String idxPath, int pageSize)

Method Summary

Modifier and Type	Method and Description
void	addWorkflowInstance(WorkflowInstance wInst) Persists the specified WorkflowInstance to the instance repository.
boolean	clearWorkflowInstances() Clears the instance repository of all workflows.
int	getNumWorkflowInstances() Gets the number of WorkflowInstances with any status being managed by this WorkflowInstanceRepository.
int	getNumWorkflowInstancesByStatus(String status) Gets the number of WorkflowInstances with the given status being managed by this WorkflowInstanceRepository.
WorkflowInstance	getWorkflowInstanceById(String workflowInstId) Returns the WorkflowInstances with the specified workflowInstId.
List	getWorkflowInstances()
List	getWorkflowInstancesByStatus(String status) Returns a List of WorkflowInstances, with the specified status String.
protected List	paginateWorkflows(int pageNum, String status)
void	removeWorkflowInstance(WorkflowInstance wInst) Removes the specified WorkflowInstance from the instance repository.
void	updateWorkflowInstance(WorkflowInstance wInst) Updates and persists the specified WorkflowInstance to the instance repository.

Methods inherited from class org.apache.oodt.cas.workflow.instrepo.AbstractPaginatibleInstanceRepository

getFirstPage, getLastPage, getNextPage, getPagedWorkflows, getPagedWorkflows, getPrevPage, paginateWorkflows

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MERGE_FACTOR

public static final int MERGE_FACTOR

See Also:

Constant Field Values

Constructor Detail

LuceneWorkflowInstanceRepository

public LuceneWorkflowInstanceRepository(String idxPath,
                                        int pageSize)

Method Detail

getNumWorkflowInstances

public int getNumWorkflowInstances()
                            throws InstanceRepositoryException

Description copied from interface: WorkflowInstanceRepository

Gets the number of WorkflowInstances with any status being managed by this WorkflowInstanceRepository.

Returns:

The number of WorkflowInstances associated with any status being managed by this WorkflowInstanceRepository.

Throws:

InstanceRepositoryException

getNumWorkflowInstancesByStatus

public int getNumWorkflowInstancesByStatus(String status)
                                    throws InstanceRepositoryException

Description copied from interface: WorkflowInstanceRepository

Gets the number of WorkflowInstances with the given status being managed by this WorkflowInstanceRepository.

Parameters:

status - The status to obtain the number of WorkflowInstances for.

Returns:

The number of WorkflowInstances with the given status.

Throws:

InstanceRepositoryException - If there is any error that occurs.

addWorkflowInstance

public void addWorkflowInstance(WorkflowInstance wInst)
                         throws InstanceRepositoryException

Description copied from interface: WorkflowInstanceRepository

Persists the specified WorkflowInstance to the instance repository.

Parameters:

wInst - The workflow instance to persist.

Throws:

InstanceRepositoryException - If any error occurs.

removeWorkflowInstance

public void removeWorkflowInstance(WorkflowInstance wInst)
                            throws InstanceRepositoryException

Description copied from interface: WorkflowInstanceRepository

Removes the specified WorkflowInstance from the instance repository.

Parameters:

wInst - The workflow instance to remove.

Throws:

InstanceRepositoryException - If any error occurs.

updateWorkflowInstance

public void updateWorkflowInstance(WorkflowInstance wInst)
                            throws InstanceRepositoryException

Description copied from interface: WorkflowInstanceRepository

Updates and persists the specified WorkflowInstance to the instance repository.

Parameters:

wInst - The workflow instance to update and persist.

Throws:

InstanceRepositoryException - If any error occurs.

getWorkflowInstanceById

public WorkflowInstance getWorkflowInstanceById(String workflowInstId)
                                         throws InstanceRepositoryException

Description copied from interface: WorkflowInstanceRepository

Returns the WorkflowInstances with the specified workflowInstId.

Parameters:

workflowInstId - The ID of the WorkflowInstance to return.

Returns:

The specified WorkflowInstance.

Throws:

InstanceRepositoryException - If any error occurs.

getWorkflowInstances

public List getWorkflowInstances()
                          throws InstanceRepositoryException

Returns:

A List of WorkflowInstances that this WorkflowEngine is managing.

Throws:

InstanceRepositoryException - If any error occurs.

clearWorkflowInstances

public boolean clearWorkflowInstances()
                               throws InstanceRepositoryException

Description copied from interface: WorkflowInstanceRepository

Clears the instance repository of all workflows.

Returns:

False if there was any error (logged), and True otherwise.

Throws:

InstanceRepositoryException - If there was some IO or other error deleting workflow instances that was unrecoverable from.

getWorkflowInstancesByStatus

public List getWorkflowInstancesByStatus(String status)
                                  throws InstanceRepositoryException

Description copied from interface: WorkflowInstanceRepository

Returns a List of WorkflowInstances, with the specified status String.

Parameters:

status - A string representation of the status of the WorkflowInstance.

Returns:

A List of WorkflowInstances, with the specified status String.

Throws:

InstanceRepositoryException - If there is any error that occurs.

paginateWorkflows

protected List paginateWorkflows(int pageNum,
                                 String status)
                          throws InstanceRepositoryException

Specified by:

paginateWorkflows in class AbstractPaginatibleInstanceRepository

Returns:

Throws:

InstanceRepositoryException