io.scanbot.genericdocument.entity

Class Field.Type

io.scanbot.genericdocument.entity.Field.Type

Enclosing class:

Field

public static class Field.Type

Field type

Constructor Detail

Type

public Type(@NotNull
            java.lang.String name,
            @NotNull
            java.lang.String fullName,
            @NotNull
            java.lang.String normalizedName,
            @Nullable
            CommonFieldType commonType)

Field type

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 - optional common field type. Commonly occurring fields that have the same semantic meaning in different document types will often have a set common type.

Method Detail

getName

@NotNull
public java.lang.String getName()

Local field type name scoped to the containing document type

getFullName

@NotNull
public java.lang.String getFullName()

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

getNormalizedName

@NotNull
public java.lang.String getNormalizedName()

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.

getCommonType

@Nullable
public CommonFieldType getCommonType()

optional common field type.

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

component1

@NotNull
public java.lang.String component1()

Local field type name scoped to the containing document type

component2

@NotNull
public java.lang.String component2()

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

component3

@NotNull
public java.lang.String component3()

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.

component4

@Nullable
public CommonFieldType component4()

optional common field type.

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

copy

@NotNull
public io.scanbot.genericdocument.entity.Field.Type copy(@NotNull
                                                                  java.lang.String name,
                                                                  @NotNull
                                                                  java.lang.String fullName,
                                                                  @NotNull
                                                                  java.lang.String normalizedName,
                                                                  @Nullable
                                                                  CommonFieldType commonType)

Field type

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)