@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Relationship extends Object implements Serializable, Cloneable, StructuredPojo
Information about how blocks are related to each other. A Block
object contains 0 or more
Relation
objects in a list, Relationships
. For more information, see Block.
The Type
element provides the type of the relationship for all blocks in the IDs
array.
Constructor and Description |
---|
Relationship() |
Modifier and Type | Method and Description |
---|---|
Relationship |
clone() |
boolean |
equals(Object obj) |
List<String> |
getIds()
An array of IDs for related blocks.
|
String |
getType()
The type of relationship between the blocks in the IDs array and the current block.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setIds(Collection<String> ids)
An array of IDs for related blocks.
|
void |
setType(String type)
The type of relationship between the blocks in the IDs array and the current block.
|
String |
toString()
Returns a string representation of this object.
|
Relationship |
withIds(Collection<String> ids)
An array of IDs for related blocks.
|
Relationship |
withIds(String... ids)
An array of IDs for related blocks.
|
Relationship |
withType(RelationshipType type)
The type of relationship between the blocks in the IDs array and the current block.
|
Relationship |
withType(String type)
The type of relationship between the blocks in the IDs array and the current block.
|
public void setType(String type)
The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.
VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.
CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.
MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.
ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.
TABLE - A list of IDs that identify associated TABLE block types.
TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.
TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.
type
- The type of relationship between the blocks in the IDs array and the current block. The following list
describes the relationship types that can be returned.
VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.
CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.
MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.
ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.
TABLE - A list of IDs that identify associated TABLE block types.
TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.
TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.
RelationshipType
public String getType()
The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.
VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.
CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.
MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.
ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.
TABLE - A list of IDs that identify associated TABLE block types.
TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.
TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.
VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.
CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.
MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.
ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.
TABLE - A list of IDs that identify associated TABLE block types.
TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.
TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.
RelationshipType
public Relationship withType(String type)
The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.
VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.
CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.
MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.
ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.
TABLE - A list of IDs that identify associated TABLE block types.
TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.
TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.
type
- The type of relationship between the blocks in the IDs array and the current block. The following list
describes the relationship types that can be returned.
VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.
CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.
MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.
ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.
TABLE - A list of IDs that identify associated TABLE block types.
TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.
TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.
RelationshipType
public Relationship withType(RelationshipType type)
The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.
VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.
CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.
MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.
ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.
TABLE - A list of IDs that identify associated TABLE block types.
TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.
TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.
type
- The type of relationship between the blocks in the IDs array and the current block. The following list
describes the relationship types that can be returned.
VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.
CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.
MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.
ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.
TABLE - A list of IDs that identify associated TABLE block types.
TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.
TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.
RelationshipType
public List<String> getIds()
An array of IDs for related blocks. You can get the type of the relationship from the Type
element.
Type
element.public void setIds(Collection<String> ids)
An array of IDs for related blocks. You can get the type of the relationship from the Type
element.
ids
- An array of IDs for related blocks. You can get the type of the relationship from the Type
element.public Relationship withIds(String... ids)
An array of IDs for related blocks. You can get the type of the relationship from the Type
element.
NOTE: This method appends the values to the existing list (if any). Use
setIds(java.util.Collection)
or withIds(java.util.Collection)
if you want to override the
existing values.
ids
- An array of IDs for related blocks. You can get the type of the relationship from the Type
element.public Relationship withIds(Collection<String> ids)
An array of IDs for related blocks. You can get the type of the relationship from the Type
element.
ids
- An array of IDs for related blocks. You can get the type of the relationship from the Type
element.public String toString()
toString
in class Object
Object.toString()
public Relationship clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.