LineSegment (SCIE PDF Text Extractor 2.0.1 API)

java.lang.Object
- de.citec.scie.pdf.structure.LineSegment

All Implemented Interfaces:

AbstractLineSegment

Direct Known Subclasses:

Document, Page, Paragraph, Text, TextBlock
```
public class LineSegment
extends Object
implements AbstractLineSegment
```
The LineSegment class implements the AbstractLineSegmentSegment interface and adds (static) utility functions that help to compare to lines.

Author:

Andreas Stoeckel - astoecke(at)techfak.uni-bielefeld.de

Field Summary

Fields
Modifier and Type Field and Description

protected int begin
Start position of the line.

protected int end
End position of the line.

Fields
Modifier and Type	Field and Description
`protected int`	`begin` Start position of the line.
`protected int`	`end` End position of the line.

Constructor Summary

Constructors
Constructor and Description
`LineSegment()` Initializes the line segment as invalid, with begin being set to INF and end being set to -INF.
`LineSegment(int begin, int end)` Initializes the line segment with the given begin and end.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`boundariesEqual(AbstractLineSegment l)` Returns true if the boundaries of the two line segments are equal.
`static boolean`	`boundariesEqual(AbstractLineSegment l1, AbstractLineSegment l2)` Returns true if the boundaries of the two line segments are equal.
`int`	`getBegin()` Returns the begin position of the line.
`int`	`getEnd()` Returns the end position of the line.
`static LineSegment`	`intersection(AbstractLineSegment l1, AbstractLineSegment l2)` Returns a new line which is the union of the two lines.
`boolean`	`isValid()` Returns true if this line is valid (its begin is smaller or equal to its end).
`static boolean`	`isValid(AbstractLineSegment line)` Returns true if the given line is valid (its begin is smaller or equal to its end).
`int`	`length()` Returns the length of the line segment.
`static int`	`length(AbstractLineSegment line)` Returns the length of the line segment.
`void`	`normalize()` Swaps begin and end if the line is not valid.
`static LineSegment`	`normalize(AbstractLineSegment line)` Normalizes the line segment by swapping begin and end if they are in the wrong order.
`static int[]`	`normalizedBounds(AbstractLineSegment line)` Returns the boundaries of the normalized line as a two-element array -- normalization means that begin and end are swapped if end is larger than begin.
`boolean`	`overlaps(AbstractLineSegment l)` Returns true if the boundaries of the two line segments overlap.
`static boolean`	`overlaps(AbstractLineSegment l1, AbstractLineSegment l2)` Returns true if the boundaries of the two line segments overlap.
`void`	`setBegin(int begin)` Sets the start position of the line.
`void`	`setEnd(int end)` Sets the end position of the line.
`static LineSegment`	`union(AbstractLineSegment l1, AbstractLineSegment l2)` Returns a new line which is the union of the two lines.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - begin
```
protected int begin
```
    Start position of the line.
  - end
```
protected int end
```
    End position of the line.
- Constructor Detail
  - LineSegment
```
public LineSegment()
```
    Initializes the line segment as invalid, with begin being set to INF and end being set to -INF.
  - LineSegment
```
public LineSegment(int begin,
                   int end)
```
    Initializes the line segment with the given begin and end.
    
    Parameters:
    
    begin - is the begin.
    
    end - is then end.
- Method Detail
  - isValid
```
public static final boolean isValid(AbstractLineSegment line)
```
    Returns true if the given line is valid (its begin is smaller or equal to its end).
    
    Parameters:
    
    line - is the line that should be checked for validity.
    
    Returns:
    
    true if the line is valid, false otherwise.
  - length
```
public static final int length(AbstractLineSegment line)
```
    Returns the length of the line segment.
    
    Parameters:
    
    line - is the line segment of which the (absolute) length is calculated.
    
    Returns:
    
    the absolute value of the length of the line segment.
  - normalize
```
public static final LineSegment normalize(AbstractLineSegment line)
```
    Normalizes the line segment by swapping begin and end if they are in the wrong order.
    
    Parameters:
    
    line - is the abstract line segment to be normalized.
    
    Returns:
    
    a new, normalized LineSegment instance.
  - normalizedBounds
```
public static final int[] normalizedBounds(AbstractLineSegment line)
```
    Returns the boundaries of the normalized line as a two-element array -- normalization means that begin and end are swapped if end is larger than begin.
    
    Parameters:
    
    line - is the line of which the (normalized) bounds are returned.
    
    Returns:
    
    a two-element array containing begin (0) and end (1).
  - union
```
public static final LineSegment union(AbstractLineSegment l1,
                                      AbstractLineSegment l2)
```
    Returns a new line which is the union of the two lines.
    
    Parameters:
    
    l1 - is the fist line segment for forming the union.
    
    l2 - is the second line segment for forming the union.
    
    Returns:
    
    a new line segment that forms the union
  - intersection
```
public static final LineSegment intersection(AbstractLineSegment l1,
                                             AbstractLineSegment l2)
```
    Returns a new line which is the union of the two lines.
    
    Parameters:
    
    l1 - is the fist line segment for forming the union.
    
    l2 - is the second line segment for forming the union.
    
    Returns:
    
    a new line segment that forms the union or null if the two line segments to not overlap.
  - boundariesEqual
```
public static final boolean boundariesEqual(AbstractLineSegment l1,
                                            AbstractLineSegment l2)
```
    Returns true if the boundaries of the two line segments are equal.
    
    Parameters:
    
    l1 - is the fist line segment for comparison.
    
    l2 - is the second line segment for comparison.
    
    Returns:
    
    true if the boundaries are equal, false otherwise.
  - overlaps
```
public static final boolean overlaps(AbstractLineSegment l1,
                                     AbstractLineSegment l2)
```
    Returns true if the boundaries of the two line segments overlap.
    
    Parameters:
    
    l1 - is the first line segment for comparison.
    
    l2 - is the second line segment for comparison.
    
    Returns:
    
    true if the boundaries of the two line segments overlap, independent of their validity (begin and end may be swaped).
  - getBegin
```
public final int getBegin()
```
    Returns the begin position of the line.
    
    Specified by:
    
    getBegin in interface AbstractLineSegment
    
    Returns:
    
    the begin position of the line.
  - getEnd
```
public final int getEnd()
```
    Returns the end position of the line.
    
    Specified by:
    
    getEnd in interface AbstractLineSegment
    
    Returns:
    
    the end position of the line.
  - setBegin
```
public final void setBegin(int begin)
```
    Sets the start position of the line.
    
    Parameters:
    
    begin - is the new start position of the line.
  - setEnd
```
public final void setEnd(int end)
```
    Sets the end position of the line.
    
    Parameters:
    
    end - is the new end position of the line.
  - isValid
```
public final boolean isValid()
```
    Returns true if this line is valid (its begin is smaller or equal to its end).
    
    Returns:
    
    true if the line is valid, false otherwise.
  - boundariesEqual
```
public final boolean boundariesEqual(AbstractLineSegment l)
```
    Returns true if the boundaries of the two line segments are equal.
    
    Parameters:
    
    l - is the line segment for comparison.
    
    Returns:
    
    true if the boundaries are equal, false otherwise.
  - overlaps
```
public final boolean overlaps(AbstractLineSegment l)
```
    Returns true if the boundaries of the two line segments overlap.
    
    Parameters:
    
    l - is the line segment for comparison.
    
    Returns:
    
    true if the boundaries of the two line segments overlap, independent of their validity (begin and end may be swaped).
  - normalize
```
public final void normalize()
```
    Swaps begin and end if the line is not valid.
  - length
```
public final int length()
```
    Returns the length of the line segment.
    
    Returns:
    
    the absolute value of the length of the line segment.

Class LineSegment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

begin

end

Constructor Detail

LineSegment

LineSegment

Method Detail

isValid

length

normalize

normalizedBounds

union

intersection

boundariesEqual

overlaps

getBegin

getEnd

setBegin

setEnd

isValid

boundariesEqual

overlaps

normalize

length