Package org.ocpsoft.prettytime.nlp.parse

Interface DateGroup

public interface DateGroup

Represents a Date instanced parsed out of natural language text.

Author:

<a href="mailto:lincolnbaxter@gmail.com>Lincoln Baxter, III

Method Summary

Modifier and Type	Method	Description
List<Date>	getDates()	Get all Date instances parsed from the language text.
int	getLine()	Get the line in which this DateGroup was found.
int	getPosition()	Get the starting position of this DateGroup in the language text.
long	getRecurInterval()	If this DateGroup is recurring, return the interval in milliseconds with which this DateGroup recurs, otherwise return -1;
Date	getRecursUntil()	Get the Date to which this DateGroup recurs.
String	getText()	Get the text fragment parsed into this DateGroup.
boolean	isRecurring()	Return true if this DateGroup is a recurring event.

Method Details

getLine

int getLine()

Get the line in which this DateGroup was found.

getText

String getText()

Get the text fragment parsed into this DateGroup.

getRecursUntil

Date getRecursUntil()

Get the Date to which this DateGroup recurs.

getPosition

int getPosition()

Get the starting position of this DateGroup in the language text.

getDates

List<Date> getDates()

Get all Date instances parsed from the language text.

isRecurring

boolean isRecurring()

Return true if this DateGroup is a recurring event.

getRecurInterval

long getRecurInterval()

If this DateGroup is recurring, return the interval in milliseconds with which this DateGroup recurs, otherwise return -1;