IndexTask (DataONE Index Common 2.3.2 API)

java.lang.Object
- org.dataone.cn.index.task.IndexTask

All Implemented Interfaces:

Serializable
```
@Entity
public class IndexTask
extends Object
implements Serializable
```
An index task is a POJO that represents an update to a DataONE managed document that needs to be reflected in the search index. An instance of an IndexTask can be processed separately from the components generating the indexTask objects. This requires the IndexTask class to carry enough information that the processing component can properly and efficiently update the search index. IndexTask is configured via Spring framework as a spring-data JPA object and is stored in relational datastore.

Author:

sroseboo

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`STATUS_COMPLETE` IndexTask processing status to represent a task that has successfully completed.
`static String`	`STATUS_FAILED` IndexTask processing status to represent a task that has failed processing.
`static String`	`STATUS_IN_PROCESS` IndexTask processing status to represent task currently being processed.
`static String`	`STATUS_NEW` IndexTask processing status of new, unprocessed.

Constructor Summary

Constructors
Constructor and Description
`IndexTask()`
`IndexTask(org.dataone.service.types.v2.SystemMetadata smd, String objectPath)` Construct an IndexTask for the given SystemMetadata and objectPath information.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getDateSysMetaModified()`
`String`	`getFormatId()`
`Long`	`getId()`
`long`	`getNextExecution()`
`String`	`getObjectPath()`
`String`	`getPid()`
`int`	`getPriority()` Private method exposed due to JPA and unit testing requirements.
`String`	`getStatus()`
`String`	`getSysMetadata()`
`String`	`getTaskModDateString()`
`long`	`getTaskModifiedDate()`
`int`	`getTryCount()`
`int`	`getVersion()`
`boolean`	`isDeleted()`
`boolean`	`isDeleteTask()` Does this task represent a removal from the search index.
`void`	`markFailed()`
`void`	`markInProgress()`
`void`	`markNew()`
`void`	`setAddPriority()` Assign add priority to this IndexTask.
`void`	`setDateSysMetaModified(long dateSysMetaModified)`
`void`	`setDeleted(boolean deleted)`
`void`	`setFormatId(String formatid)`
`void`	`setId(Long id)`
`void`	`setNextExection(long next)`
`void`	`setObjectPath(String objectPath)`
`void`	`setPid(String pid)`
`void`	`setPriority(int priority)` Private method exposed due to JPA and unit testing requirements.
`void`	`setStatus(String status)` Do not use this method, used by unit tests only.
`void`	`setSysMetadata(String sysMetadata)`
`void`	`setTaskModifiedDate(long taskModifiedDate)`
`void`	`setTryCount(int count)`
`void`	`setUpdatePriority()` Assign update priority to this IndexTask.
`void`	`setVersion(int version)`
`String`	`toString()`
`org.dataone.service.types.v2.SystemMetadata`	`unMarshalSystemMetadata()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - STATUS_NEW
```
public static final String STATUS_NEW
```
    IndexTask processing status of new, unprocessed.
    
    See Also:
    
    Constant Field Values
  - STATUS_IN_PROCESS
```
public static final String STATUS_IN_PROCESS
```
    IndexTask processing status to represent task currently being processed.
    
    See Also:
    
    Constant Field Values
  - STATUS_COMPLETE
```
public static final String STATUS_COMPLETE
```
    IndexTask processing status to represent a task that has successfully completed.
    
    See Also:
    
    Constant Field Values
  - STATUS_FAILED
```
public static final String STATUS_FAILED
```
    IndexTask processing status to represent a task that has failed processing.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IndexTask
```
public IndexTask()
```
  - IndexTask
```
public IndexTask(org.dataone.service.types.v2.SystemMetadata smd,
                 String objectPath)
```
    Construct an IndexTask for the given SystemMetadata and objectPath information.
    
    Parameters:
    
    smd -
    
    objectPath -
- Method Detail
  - unMarshalSystemMetadata
```
public org.dataone.service.types.v2.SystemMetadata unMarshalSystemMetadata()
```
  - isDeleteTask
```
public boolean isDeleteTask()
```
    Does this task represent a removal from the search index.
    
    Returns:
  - getId
```
public Long getId()
```
  - setId
```
public void setId(Long id)
```
  - getPid
```
public String getPid()
```
  - setPid
```
public void setPid(String pid)
```
  - isDeleted
```
public boolean isDeleted()
```
  - setDeleted
```
public void setDeleted(boolean deleted)
```
  - getFormatId
```
public String getFormatId()
```
  - setFormatId
```
public void setFormatId(String formatid)
```
  - getSysMetadata
```
public String getSysMetadata()
```
  - setSysMetadata
```
public void setSysMetadata(String sysMetadata)
```
  - getObjectPath
```
public String getObjectPath()
```
  - setObjectPath
```
public void setObjectPath(String objectPath)
```
  - getDateSysMetaModified
```
public long getDateSysMetaModified()
```
  - setDateSysMetaModified
```
public void setDateSysMetaModified(long dateSysMetaModified)
```
  - getNextExecution
```
public long getNextExecution()
```
  - setNextExection
```
public void setNextExection(long next)
```
  - getTryCount
```
public int getTryCount()
```
  - setTryCount
```
public void setTryCount(int count)
```
  - getPriority
```
public int getPriority()
```
    Private method exposed due to JPA and unit testing requirements. Should not use directly.
    
    Returns:
  - setPriority
```
public void setPriority(int priority)
```
    Private method exposed due to JPA and unit testing requirements. Should not use directly. See setUpdatePriority, setAddPriority methods.
  - setUpdatePriority
```
public void setUpdatePriority()
```
    Assign update priority to this IndexTask. Priority is used by processing to determine what order to process IndexTasks.
  - setAddPriority
```
public void setAddPriority()
```
    Assign add priority to this IndexTask. Priority is used by processing to determine what order to process IndexTasks.
  - getTaskModifiedDate
```
public long getTaskModifiedDate()
```
  - setTaskModifiedDate
```
public void setTaskModifiedDate(long taskModifiedDate)
```
  - getTaskModDateString
```
public String getTaskModDateString()
```
  - getStatus
```
public String getStatus()
```
  - setStatus
```
public void setStatus(String status)
```
    Do not use this method, used by unit tests only. use the specific 'markNew, markFailed, markInProcess' methods.
  - markInProgress
```
public void markInProgress()
```
  - markNew
```
public void markNew()
```
  - markFailed
```
public void markFailed()
```
  - getVersion
```
public int getVersion()
```
  - setVersion
```
public void setVersion(int version)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class IndexTask

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_NEW

STATUS_IN_PROCESS

STATUS_COMPLETE

STATUS_FAILED

Constructor Detail

IndexTask

IndexTask

Method Detail

unMarshalSystemMetadata

isDeleteTask

getId

setId

getPid

setPid

isDeleted

setDeleted

getFormatId

setFormatId

getSysMetadata

setSysMetadata

getObjectPath

setObjectPath

getDateSysMetaModified

setDateSysMetaModified

getNextExecution

setNextExection

getTryCount

setTryCount

getPriority

setPriority

setUpdatePriority

setAddPriority

getTaskModifiedDate

setTaskModifiedDate

getTaskModDateString

getStatus

setStatus

markInProgress

markNew

markFailed

getVersion

setVersion

toString