Package io.scanbot.sdk.genericdocument

Class FieldType

java.lang.Object

io.scanbot.sdk.genericdocument.FieldType

public class FieldType
extends java.lang.Object

Generic Document Type.

Constructor Summary

Constructors

Constructor	Description
FieldType(java.lang.String name, java.lang.String fullName, java.lang.String normalizedName, CommonFieldType commonType)	Constructs FieldType with default parameters.
FieldType(java.lang.String name, java.lang.String fullName, java.lang.String normalizedName, CommonFieldType commonType, java.lang.Integer listIndex)	Constructs FieldType with the given params.

Method Summary

Modifier and Type	Method	Description
CommonFieldType	getCommonType()	Getter for commonType field.
java.lang.String	getFullName()	Getter for fullName field.
java.lang.Integer	getListIndex()	Getter for listIndex field.
java.lang.String	getName()	Getter for name field.
java.lang.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 Detail

FieldType

public FieldType(java.lang.String name,
                 java.lang.String fullName,
                 java.lang.String normalizedName,
                 CommonFieldType commonType,
                 java.lang.Integer listIndex)

Constructs FieldType with the given params.

Parameters:

name - Local field type name scoped to the containing document type.

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

normalizedName - Normalized global field type name. Fields in document types derived from the same base document type in the schema will have the same normalized name.

commonType - Commonly occurring fields that have the same semantic meaning in different document types will often have a set common type.

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.

FieldType

public FieldType(java.lang.String name,
                 java.lang.String fullName,
                 java.lang.String normalizedName,
                 CommonFieldType commonType)

Constructs FieldType with default parameters.

Parameters:

name - Local field type name scoped to the containing document type.

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

normalizedName - Normalized global field type name. Fields in document types derived from the same base document type in the schema will have the same normalized name.

commonType - Commonly occurring fields that have the same semantic meaning in different document types will often have a set common type.

Method Detail

getName

public java.lang.String getName()

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

Returns:

name

getFullName

public java.lang.String getFullName()

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

Returns:

fullName

getNormalizedName

public java.lang.String getNormalizedName()

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

Returns:

normalizedName

getCommonType

public CommonFieldType getCommonType()

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

Returns:

commonType

getListIndex

public java.lang.Integer getListIndex()

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

Returns:

listIndex