Package io.scanbot.sdk.genericdocument

Class GenericDocumentType

java.lang.Object

io.scanbot.sdk.genericdocument.GenericDocumentType

public class GenericDocumentType
extends Object

Generic Document Type.

Constructor Summary

Constructors

Constructor	Description
GenericDocumentType(String name, String fullName, String normalizedName)	Constructs GenericDocumentType with default parameters.
GenericDocumentType(String name, String fullName, String normalizedName, Integer listIndex)	Constructs GenericDocumentType with the given params.

Method Summary

Modifier and Type	Method	Description
String	getFullName()	Getter for fullName field.
Integer	getListIndex()	Getter for listIndex field.
String	getName()	Getter for name field.
String	getNormalizedName()	Getter for normalizedName field.

Methods inherited from class java.lang.Object

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

Constructor Details

GenericDocumentType

public GenericDocumentType(String name,
 String fullName,
 String normalizedName,
 Integer listIndex)

Constructs GenericDocumentType with the given params.

Parameters:

name - Local document type name.

fullName - Unique global document type name prefixed with the document types of all containing documents.

normalizedName - Normalized global document type name. Common document types appearing as child documents in different places will often have the same normalized type name.

listIndex - A document can contain multiple fields of the same name, the property serves for storing natural order of such fields, null if multiple entries aren't allowed for this field.

GenericDocumentType

public GenericDocumentType(String name,
 String fullName,
 String normalizedName)

Constructs GenericDocumentType with default parameters.

Parameters:

name - Local document type name.

fullName - Unique global document type name prefixed with the document types of all containing documents.

normalizedName - Normalized global document type name. Common document types appearing as child documents in different places will often have the same normalized type name.

Method Details

getName

public String getName()

Getter for name field. See constructor documentation for more information about the field.

Returns:

name

getFullName

public String getFullName()

Getter for fullName field. See constructor documentation for more information about the field.

Returns:

fullName

getNormalizedName

public String getNormalizedName()

Getter for normalizedName field. See constructor documentation for more information about the field.

Returns:

normalizedName

getListIndex

public Integer getListIndex()

Getter for listIndex field. See constructor documentation for more information about the field.

Returns:

listIndex