public class DocumentOperationInput extends Object
DocumentOperation.getOptions(DocumentOperationInput)| Constructor and Description |
|---|
DocumentOperationInput(AnnotatedPluginDocument... inputDocuments)
Constructs new DocumentOperationInput.
|
DocumentOperationInput(List<AnnotatedPluginDocument> inputDocuments)
Constructs new DocumentOperationInput.
|
| Modifier and Type | Method and Description |
|---|---|
AnnotatedPluginDocument[] |
getInputDocumentsArray() |
List<AnnotatedPluginDocument> |
getInputDocumentsList() |
OperationLocationOptions |
getLocationOptions()
Gets the location options used to control where the operation is run.
|
WritableDatabaseService |
getResultsLocation() |
SequenceSelection |
getSequenceSelection() |
DocumentOperationInput |
setLocationOptions(OperationLocationOptions locationOptions)
Sets the location options to be used for this operation.
|
DocumentOperationInput |
setResultsLocation(WritableDatabaseService resultsLocation)
Sets the results location to be used for this operation.
|
DocumentOperationInput |
setSequenceSelection(SequenceSelection sequenceSelection)
Sets the sequence selection to be used for this operation.
|
public DocumentOperationInput(List<AnnotatedPluginDocument> inputDocuments)
inputDocuments - the documents to be used as input to this operation. May not be null but may be emptypublic DocumentOperationInput(AnnotatedPluginDocument... inputDocuments)
inputDocuments - the documents to be used as input to this operation. May not be null but may be emptypublic DocumentOperationInput setLocationOptions(OperationLocationOptions locationOptions)
locationOptions - the location options to be used for this operation. May be null if this operation can only be run locally.IllegalStateException - if this method is called more than once.public DocumentOperationInput setSequenceSelection(SequenceSelection sequenceSelection)
sequenceSelection - the sequence selection to be used for this operation. Never null but may be an empty selectionIllegalStateException - if this method is called more than once.public DocumentOperationInput setResultsLocation(WritableDatabaseService resultsLocation)
resultsLocation - the folder that the results of the operation will be stored in. May be null if results are not being stored.IllegalStateException - if this method is called more than once.public List<AnnotatedPluginDocument> getInputDocumentsList()
public AnnotatedPluginDocument[] getInputDocumentsArray()
public OperationLocationOptions getLocationOptions()
OperationLocationOptions for more details.public SequenceSelection getSequenceSelection()
public WritableDatabaseService getResultsLocation()
DocumentOperation.isDocumentGenerator() is false for this operation).