Class TranskribusJob
java.lang.Object
io.goobi.viewer.model.transkribus.TranskribusJob
- All Implemented Interfaces:
Serializable
Represents a Transkribus HTR (handwritten text recognition) processing job with its status and associated record.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringDescription field for stack traces, etc.E-mail recipients that will be notified once the download generation is complete. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGetter for the fielddateCreated.Getter for the fielddescription.getDocId()Getter for the fielddocId.getId()Getter for the fieldid.getJobId()Getter for the fieldjobId.Getter for the fieldmessage.Getter for the fieldobservers.Getter for the fieldownerId.getPi()Getter for the fieldpi.Getter for the fieldstatus.Getter for the fielduserCollectionId.Getter for the fieldviewerCollectionId.voidsetDateCreated(LocalDateTime dateCreated) Setter for the fielddateCreated.voidsetDescription(String description) Setter for the fielddescription.voidSetter for the fielddocId.voidSetter for the fieldid.voidSetter for the fieldjobId.voidsetMessage(String message) Setter for the fieldmessage.voidsetObservers(List<String> observers) Setter for the fieldobservers.voidsetOwnerId(String ownerId) Setter for the fieldownerId.voidSetter for the fieldpi.voidSetter for the fieldstatus.voidsetUserCollectionId(String userCollectionId) Setter for the fielduserCollectionId.voidsetViewerCollectionId(String viewerCollectionId) Setter for the fieldviewerCollectionId.
-
Field Details
-
description
Description field for stack traces, etc. -
observers
E-mail recipients that will be notified once the download generation is complete.
-
-
Constructor Details
-
TranskribusJob
public TranskribusJob()
-
-
Method Details
-
getId
Getter for the fieldid.- Returns:
- the database identifier of this Transkribus job
-
setId
Setter for the fieldid.- Parameters:
id- the database identifier to set
-
getJobId
Getter for the fieldjobId.- Returns:
- the Transkribus job identifier
-
setJobId
Setter for the fieldjobId.- Parameters:
jobId- the Transkribus job identifier to set
-
getDocId
Getter for the fielddocId.- Returns:
- the Transkribus document identifier
-
setDocId
Setter for the fielddocId.- Parameters:
docId- the Transkribus document identifier to set
-
getPi
Getter for the fieldpi.- Returns:
- the persistent identifier of the associated Goobi viewer record
-
setPi
Setter for the fieldpi.- Parameters:
pi- the persistent identifier of the Goobi viewer record to set
-
getOwnerId
Getter for the fieldownerId.- Returns:
- the identifier of the user who submitted this job
-
setOwnerId
Setter for the fieldownerId.- Parameters:
ownerId- the identifier of the user who submitted this job to set
-
getUserCollectionId
Getter for the fielduserCollectionId.- Returns:
- the user's Transkribus collection identifier
-
setUserCollectionId
Setter for the fielduserCollectionId.- Parameters:
userCollectionId- the user's Transkribus collection identifier to set
-
getViewerCollectionId
Getter for the fieldviewerCollectionId.- Returns:
- the viewer's Transkribus collection identifier
-
setViewerCollectionId
Setter for the fieldviewerCollectionId.- Parameters:
viewerCollectionId- the viewer's Transkribus collection identifier to set
-
getMessage
Getter for the fieldmessage.- Returns:
- the status or error message from Transkribus
-
setMessage
Setter for the fieldmessage.- Parameters:
message- the status or error message from Transkribus to set
-
getDateCreated
Getter for the fielddateCreated.- Returns:
- the timestamp when this job was created
-
setDateCreated
Setter for the fielddateCreated.- Parameters:
dateCreated- the timestamp when this job was created to set
-
getStatus
Getter for the fieldstatus.- Returns:
- the current processing status of this job
-
setStatus
Setter for the fieldstatus.- Parameters:
status- the current processing status of this job to set
-
getDescription
Getter for the fielddescription.- Returns:
- a human-readable description of this job
-
setDescription
Setter for the fielddescription.- Parameters:
description- a human-readable description of this job to set
-
getObservers
Getter for the fieldobservers.- Returns:
- the list of email addresses to notify about job status changes
-
setObservers
Setter for the fieldobservers.- Parameters:
observers- the list of email addresses to notify about job status changes to set
-