Package com.mindee.parsing.v2.field

Class ObjectField

java.lang.Object

com.mindee.parsing.v2.field.BaseField

com.mindee.parsing.v2.field.ObjectField

public class ObjectField
extends BaseField

Field holding a map of sub-fields.

Constructor Summary

Constructors

Constructor	Description
ObjectField()
ObjectField(InferenceFields fields)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
InferenceFields	getFields()	Sub-fields keyed by their name.
ListField	getListField(String fieldKey)	Retrieves a list sub-field from the fields map as a ListField.
LinkedHashMap<String,ListField>	getListFields()	Retrieves all subfields from the fields map as a LinkedHashMap of ListField objects, keyed by their field names.
ObjectField	getObjectField(String fieldKey)	Retrieves an object sub-field from the fields map as a ObjectField.
LinkedHashMap<String,ObjectField>	getObjectFields()	Retrieves all subfields from the fields map as a LinkedHashMap of ObjectField objects, keyed by their field names.
SimpleField	getSimpleField(String fieldKey)	Retrieves a single sub-field from the fields map as a SimpleField.
LinkedHashMap<String,SimpleField>	getSimpleFields()	Retrieves all sub-fields from the fields map as a LinkedHashMap of SimpleField objects, keyed by their field names.
int	hashCode()
String	toString()
String	toStringFromList()

Methods inherited from class com.mindee.parsing.v2.field.BaseField

getConfidence, getLocations, setConfidence, setLocations

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectField

public ObjectField(InferenceFields fields)

ObjectField

public ObjectField()

Method Detail

getSimpleFields

public LinkedHashMap<String,SimpleField> getSimpleFields()
                                                        throws IllegalStateException

Retrieves all sub-fields from the fields map as a LinkedHashMap of SimpleField objects, keyed by their field names.

Returns:

a LinkedHashMap containing the field names as keys and their corresponding SimpleField instances as values

Throws:

IllegalStateException - if any field is not of type SIMPLE_FIELD

getListFields

public LinkedHashMap<String,ListField> getListFields()

Retrieves all subfields from the fields map as a LinkedHashMap of ListField objects, keyed by their field names.

Returns:

a LinkedHashMap containing the field names as keys and their corresponding ListField instances as values (only includes fields that are list fields)

getObjectFields

public LinkedHashMap<String,ObjectField> getObjectFields()

Retrieves all subfields from the fields map as a LinkedHashMap of ObjectField objects, keyed by their field names.

Returns:

a LinkedHashMap containing the field names as keys and their corresponding ObjectField objects as values

getSimpleField

public SimpleField getSimpleField(String fieldKey)
                           throws IllegalStateException

Retrieves a single sub-field from the fields map as a SimpleField.

Parameters:

fieldKey - the name/key of the field to retrieve

Returns:

the corresponding SimpleField, or null if fields is null or if no field exists for fieldKey (depending on fields' behavior)

Throws:

IllegalStateException - if the referenced field exists but is not of type SIMPLE_FIELD

getListField

public ListField getListField(String fieldKey)

Retrieves a list sub-field from the fields map as a ListField.

Parameters:

fieldKey - the name/key of the field to retrieve

Returns:

the corresponding ListField, or null if fields is null or if no field exists for fieldKey (depending on fields' behavior)

Throws:

IllegalStateException - if the referenced field exists but is not of type LIST_FIELD

getObjectField

public ObjectField getObjectField(String fieldKey)

Retrieves an object sub-field from the fields map as a ObjectField.

Parameters:

fieldKey - the name/key of the field to retrieve

Returns:

the corresponding ObjectField, or null if fields is null or if no field exists for fieldKey (depending on fields' behavior)

Throws:

IllegalStateException - if the referenced field exists but is not of type OBJECT_FIELD

toString

public String toString()

Overrides:

toString in class BaseField

toStringFromList

public String toStringFromList()

getFields

public InferenceFields getFields()

Sub-fields keyed by their name.

equals

public boolean equals(Object o)

Overrides:

equals in class BaseField

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class BaseField

hashCode

public int hashCode()

Overrides:

hashCode in class BaseField