com.affinda.api.client.models

Class DocumentCollection

java.lang.Object

com.affinda.api.client.models.DocumentCollection

public final class DocumentCollection
extends Object

The DocumentCollection model.

Constructor Summary

Constructors

Constructor and Description
DocumentCollection()

Method Summary

Modifier and Type	Method and Description
Float	getAutoValidationThreshold() Get the autoValidationThreshold property: The autoValidationThreshold property.
Integer	getConfirmedDocsCount() Get the confirmedDocsCount property: Number of validated documents in the collection.
DocumentCollectionDateFormatPreference	getDateFormatPreference() Get the dateFormatPreference property: The dateFormatPreference property.
Extractor	getExtractor() Get the extractor property: The extractor property.
Map<String,Object>	getExtractorConfig() Get the extractorConfig property: Extra configurations specific to an extractor.
List<FieldGroup>	getFields() Get the fields property: The fields property.
String	getIdentifier() Get the identifier property: Uniquely identify a collection.
String	getIngestEmail() Get the ingestEmail property: The ingestEmail property.
String	getName() Get the name property: The name property.
Integer	getUnvalidatedDocsCount() Get the unvalidatedDocsCount property: Number of unvalidated documents in the collection.
DocumentCollectionWorkspace	getWorkspace() Get the workspace property: The workspace property.
Boolean	isDateFormatFromDocument() Get the dateFormatFromDocument property: Predict the date format from any dates in the document that is not ambiguous.
Boolean	isFieldsConfigured() Get the fieldsConfigured property: The fieldsConfigured property.
DocumentCollection	setAutoValidationThreshold(Float autoValidationThreshold) Set the autoValidationThreshold property: The autoValidationThreshold property.
DocumentCollection	setConfirmedDocsCount(Integer confirmedDocsCount) Set the confirmedDocsCount property: Number of validated documents in the collection.
DocumentCollection	setDateFormatFromDocument(Boolean dateFormatFromDocument) Set the dateFormatFromDocument property: Predict the date format from any dates in the document that is not ambiguous.
DocumentCollection	setDateFormatPreference(DocumentCollectionDateFormatPreference dateFormatPreference) Set the dateFormatPreference property: The dateFormatPreference property.
DocumentCollection	setExtractor(Extractor extractor) Set the extractor property: The extractor property.
DocumentCollection	setExtractorConfig(Map<String,Object> extractorConfig) Set the extractorConfig property: Extra configurations specific to an extractor.
DocumentCollection	setFields(List<FieldGroup> fields) Set the fields property: The fields property.
DocumentCollection	setFieldsConfigured(Boolean fieldsConfigured) Set the fieldsConfigured property: The fieldsConfigured property.
DocumentCollection	setIdentifier(String identifier) Set the identifier property: Uniquely identify a collection.
DocumentCollection	setIngestEmail(String ingestEmail) Set the ingestEmail property: The ingestEmail property.
DocumentCollection	setName(String name) Set the name property: The name property.
DocumentCollection	setUnvalidatedDocsCount(Integer unvalidatedDocsCount) Set the unvalidatedDocsCount property: Number of unvalidated documents in the collection.
DocumentCollection	setWorkspace(DocumentCollectionWorkspace workspace) Set the workspace property: The workspace property.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentCollection

public DocumentCollection()

Method Detail

getIdentifier

public String getIdentifier()

Get the identifier property: Uniquely identify a collection.

Returns:

the identifier value.

setIdentifier

public DocumentCollection setIdentifier(String identifier)

Set the identifier property: Uniquely identify a collection.

Parameters:

identifier - the identifier value to set.

Returns:

the DocumentCollection object itself.

getName

public String getName()

Get the name property: The name property.

Returns:

the name value.

setName

public DocumentCollection setName(String name)

Set the name property: The name property.

Parameters:

name - the name value to set.

Returns:

the DocumentCollection object itself.

getWorkspace

public DocumentCollectionWorkspace getWorkspace()

Get the workspace property: The workspace property.

Returns:

the workspace value.

setWorkspace

public DocumentCollection setWorkspace(DocumentCollectionWorkspace workspace)

Set the workspace property: The workspace property.

Parameters:

workspace - the workspace value to set.

Returns:

the DocumentCollection object itself.

getExtractor

public Extractor getExtractor()

Get the extractor property: The extractor property.

Returns:

the extractor value.

setExtractor

public DocumentCollection setExtractor(Extractor extractor)

Set the extractor property: The extractor property.

Parameters:

extractor - the extractor value to set.

Returns:

the DocumentCollection object itself.

getAutoValidationThreshold

public Float getAutoValidationThreshold()

Get the autoValidationThreshold property: The autoValidationThreshold property.

Returns:

the autoValidationThreshold value.

setAutoValidationThreshold

public DocumentCollection setAutoValidationThreshold(Float autoValidationThreshold)

Set the autoValidationThreshold property: The autoValidationThreshold property.

Parameters:

autoValidationThreshold - the autoValidationThreshold value to set.

Returns:

the DocumentCollection object itself.

getFields

public List<FieldGroup> getFields()

Get the fields property: The fields property.

Returns:

the fields value.

setFields

public DocumentCollection setFields(List<FieldGroup> fields)

Set the fields property: The fields property.

Parameters:

fields - the fields value to set.

Returns:

the DocumentCollection object itself.

isFieldsConfigured

public Boolean isFieldsConfigured()

Get the fieldsConfigured property: The fieldsConfigured property.

Returns:

the fieldsConfigured value.

setFieldsConfigured

public DocumentCollection setFieldsConfigured(Boolean fieldsConfigured)

Set the fieldsConfigured property: The fieldsConfigured property.

Parameters:

fieldsConfigured - the fieldsConfigured value to set.

Returns:

the DocumentCollection object itself.

getDateFormatPreference

public DocumentCollectionDateFormatPreference getDateFormatPreference()

Get the dateFormatPreference property: The dateFormatPreference property.

Returns:

the dateFormatPreference value.

setDateFormatPreference

public DocumentCollection setDateFormatPreference(DocumentCollectionDateFormatPreference dateFormatPreference)

Set the dateFormatPreference property: The dateFormatPreference property.

Parameters:

dateFormatPreference - the dateFormatPreference value to set.

Returns:

the DocumentCollection object itself.

isDateFormatFromDocument

public Boolean isDateFormatFromDocument()

Get the dateFormatFromDocument property: Predict the date format from any dates in the document that is not ambiguous.

Returns:

the dateFormatFromDocument value.

setDateFormatFromDocument

public DocumentCollection setDateFormatFromDocument(Boolean dateFormatFromDocument)

Set the dateFormatFromDocument property: Predict the date format from any dates in the document that is not ambiguous.

Parameters:

dateFormatFromDocument - the dateFormatFromDocument value to set.

Returns:

the DocumentCollection object itself.

getExtractorConfig

public Map<String,Object> getExtractorConfig()

Get the extractorConfig property: Extra configurations specific to an extractor.

Returns:

the extractorConfig value.

setExtractorConfig

public DocumentCollection setExtractorConfig(Map<String,Object> extractorConfig)

Set the extractorConfig property: Extra configurations specific to an extractor.

Parameters:

extractorConfig - the extractorConfig value to set.

Returns:

the DocumentCollection object itself.

getUnvalidatedDocsCount

public Integer getUnvalidatedDocsCount()

Get the unvalidatedDocsCount property: Number of unvalidated documents in the collection.

Returns:

the unvalidatedDocsCount value.

setUnvalidatedDocsCount

public DocumentCollection setUnvalidatedDocsCount(Integer unvalidatedDocsCount)

Set the unvalidatedDocsCount property: Number of unvalidated documents in the collection.

Parameters:

unvalidatedDocsCount - the unvalidatedDocsCount value to set.

Returns:

the DocumentCollection object itself.

getConfirmedDocsCount

public Integer getConfirmedDocsCount()

Get the confirmedDocsCount property: Number of validated documents in the collection.

Returns:

the confirmedDocsCount value.

setConfirmedDocsCount

public DocumentCollection setConfirmedDocsCount(Integer confirmedDocsCount)

Set the confirmedDocsCount property: Number of validated documents in the collection.

Parameters:

confirmedDocsCount - the confirmedDocsCount value to set.

Returns:

the DocumentCollection object itself.

getIngestEmail

public String getIngestEmail()

Get the ingestEmail property: The ingestEmail property.

Returns:

the ingestEmail value.

setIngestEmail

public DocumentCollection setIngestEmail(String ingestEmail)

Set the ingestEmail property: The ingestEmail property.

Parameters:

ingestEmail - the ingestEmail value to set.

Returns:

the DocumentCollection object itself.