com.ibm.watson.compare_comply.v1.model

Class SectionTitles

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.compare_comply.v1.model.SectionTitles

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class SectionTitles
extends com.ibm.cloud.sdk.core.service.model.GenericModel

An array containing one object per section or subsection detected in the input document. Sections and subsections are not nested; instead, they are flattened out and can be placed back in order by using the `begin` and `end` values of the element and the `level` value of the section.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<ElementLocations>	elementLocations
protected java.lang.Long	level
protected Location	location
protected java.lang.String	text

Constructor Summary

Constructors

Constructor and Description
SectionTitles()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<ElementLocations>	getElementLocations() Gets the elementLocations.
java.lang.Long	getLevel() Gets the level.
Location	getLocation() Gets the location.
java.lang.String	getText() Gets the text.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

text

protected java.lang.String text

location

protected Location location

level

protected java.lang.Long level

elementLocations

@SerializedName(value="element_locations")
protected java.util.List<ElementLocations> elementLocations

Constructor Detail

SectionTitles

public SectionTitles()

Method Detail

getText

public java.lang.String getText()

Gets the text.

The text of the section title, if identified.

Returns:

the text

getLocation

public Location getLocation()

Gets the location.

The numeric location of the identified element in the document, represented with two integers labeled `begin` and `end`.

Returns:

the location

getLevel

public java.lang.Long getLevel()

Gets the level.

An integer indicating the level at which the section is located in the input document. For example, `1` represents a top-level section, `2` represents a subsection within the level `1` section, and so forth.

Returns:

the level

getElementLocations

public java.util.List<ElementLocations> getElementLocations()

Gets the elementLocations.

An array of `location` objects that lists the locations of detected section titles.

Returns:

the elementLocations