RuleBasedSegmenter (ixa-pipe-tok 1.8.0 API)

java.lang.Object
- eus.ixa.ixa.pipe.seg.RuleBasedSegmenter

All Implemented Interfaces:

SentenceSegmenter
```
public class RuleBasedSegmenter
extends Object
implements SentenceSegmenter
```
Rule based SentenceSegmenter. It also removes possible spurious paragraphs and newlines. Exceptions are managed by the NonPeriodBreaker class.

Version:

2015-04-14

Author:

ragerri

Field Summary

Fields
Modifier and Type	Field and Description
`static Pattern`	`alphaNumParaLowerNum` Alphanumeric, maybe a space, paragraph mark, maybe a space, and lowercase letter or digit.
`static Pattern`	`conventionalPara` End of sentence marker, one or more paragraph marks, maybe some starting punctuation, uppercase.
`static Pattern`	`doubleLineBreak` Two lines.
`static Pattern`	`endInsideQuotesPara` End of sentence marker, maybe a space, punctuation (quotes, brackets), space, maybe some more punctuation, maybe some space and uppercase.
`static Pattern`	`endInsideQuotesSpace` End of sentence marker, maybe a space, punctuation (quotes, brackets), space, maybe some more punctuation, maybe some space and uppercase.
`static Pattern`	`endPunctLinkPara` End of sentence markers, paragraph mark and link.
`static Pattern`	`endPunctLinkSpace` End of sentence punctuation, maybe spaces and link.
`static String`	`FINAL_PUNCT` Final punctuation in unicode.
`static String`	`INITIAL_PUNCT` Initial punctuation in unicode.
`static String`	`LINE_BREAK` The constant representing every line break in the original input text.
`static Pattern`	`lineBreak` Line break pattern.
`static Pattern`	`multiDotsParaStarters` Multi-dots, paragraph mark, sentence starters and uppercase.
`static Pattern`	`multiDotsSpaceStarters` Multi-dots, space, sentence starters and uppercase.
`static Pattern`	`noPeriodSpaceEnd` Non-period end of sentence markers (?!), one or more spaces, sentence starters.
`static Pattern`	`paragraph` Paragraph pattern.
`static String`	`PARAGRAPH` Constant representing a paragraph (a doubleLine) in the original input text.
`static Pattern`	`punctSpaceUpper` End of sentence marker, sentence starter punctuation and upper case.
`static Pattern`	`spuriousParagraph` If paragraph mark, maybe some space and lowercase or punctuation (not start of sentence markers) then it is a spurious paragraph.

Constructor Summary

Constructors
Constructor and Description
`RuleBasedSegmenter(String originalText, Properties properties)` Construct a RuleBasedSegmenter from a BufferedReader and the properties.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

static String buildText(String text)

String[] segmentSentence()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`buildText(String text)`
`String[]`	`segmentSentence()`

- Field Detail
  - LINE_BREAK
```
public static final String LINE_BREAK
```
    The constant representing every line break in the original input text.
    
    See Also:
    
    Constant Field Values
  - PARAGRAPH
```
public static final String PARAGRAPH
```
    Constant representing a paragraph (a doubleLine) in the original input text.
    
    See Also:
    
    Constant Field Values
  - lineBreak
```
public static Pattern lineBreak
```
    Line break pattern.
  - doubleLineBreak
```
public static Pattern doubleLineBreak
```
    Two lines.
  - paragraph
```
public static Pattern paragraph
```
    Paragraph pattern.
  - INITIAL_PUNCT
```
public static String INITIAL_PUNCT
```
    Initial punctuation in unicode.
  - FINAL_PUNCT
```
public static String FINAL_PUNCT
```
    Final punctuation in unicode.
  - endPunctLinkPara
```
public static Pattern endPunctLinkPara
```
    End of sentence markers, paragraph mark and link.
  - conventionalPara
```
public static Pattern conventionalPara
```
    End of sentence marker, one or more paragraph marks, maybe some starting punctuation, uppercase.
  - endInsideQuotesPara
```
public static Pattern endInsideQuotesPara
```
    End of sentence marker, maybe a space, punctuation (quotes, brackets), space, maybe some more punctuation, maybe some space and uppercase.
  - multiDotsParaStarters
```
public static Pattern multiDotsParaStarters
```
    Multi-dots, paragraph mark, sentence starters and uppercase.
  - spuriousParagraph
```
public static Pattern spuriousParagraph
```
    If paragraph mark, maybe some space and lowercase or punctuation (not start of sentence markers) then it is a spurious paragraph.
  - alphaNumParaLowerNum
```
public static Pattern alphaNumParaLowerNum
```
    Alphanumeric, maybe a space, paragraph mark, maybe a space, and lowercase letter or digit.
  - noPeriodSpaceEnd
```
public static Pattern noPeriodSpaceEnd
```
    Non-period end of sentence markers (?!), one or more spaces, sentence starters.
  - multiDotsSpaceStarters
```
public static Pattern multiDotsSpaceStarters
```
    Multi-dots, space, sentence starters and uppercase.
  - endInsideQuotesSpace
```
public static Pattern endInsideQuotesSpace
```
    End of sentence marker, maybe a space, punctuation (quotes, brackets), space, maybe some more punctuation, maybe some space and uppercase.
  - punctSpaceUpper
```
public static Pattern punctSpaceUpper
```
    End of sentence marker, sentence starter punctuation and upper case.
  - endPunctLinkSpace
```
public static Pattern endPunctLinkSpace
```
    End of sentence punctuation, maybe spaces and link.
- Constructor Detail
  - RuleBasedSegmenter
```
public RuleBasedSegmenter(String originalText,
                          Properties properties)
```
    Construct a RuleBasedSegmenter from a BufferedReader and the properties.
    
    Parameters:
    
    originalText - the text to be segmented
    
    properties - the properties
- Method Detail
  - segmentSentence
```
public String[] segmentSentence()
```
    Specified by:
    
    segmentSentence in interface SentenceSegmenter
  - buildText
```
public static String buildText(String text)
```

Class RuleBasedSegmenter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LINE_BREAK

PARAGRAPH

lineBreak

doubleLineBreak

paragraph

INITIAL_PUNCT

FINAL_PUNCT

endPunctLinkPara

conventionalPara

endInsideQuotesPara

multiDotsParaStarters

spuriousParagraph

alphaNumParaLowerNum

noPeriodSpaceEnd

multiDotsSpaceStarters

endInsideQuotesSpace

punctSpaceUpper

endPunctLinkSpace

Constructor Detail

RuleBasedSegmenter

Method Detail

segmentSentence

buildText