com.joestelmach.natty

Class DateGroup

java.lang.Object

com.joestelmach.natty.DateGroup

public class DateGroup
extends Object

Author:

Joe Stelmach

Constructor Summary

Constructors

Constructor and Description
DateGroup()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDate(Date date) Adds a date to this group
int	getAbsolutePosition()
List<Date>	getDates()
String	getFullText()
int	getLine() The line within the fullText this date group is found on
Map<String,List<ParseLocation>>	getParseLocations()
int	getPosition()
String	getPrefix(int length)
Date	getRecursUntil()
String	getSuffix(int length)
org.antlr.runtime.tree.Tree	getSyntaxTree()
String	getText()
boolean	isDateInferred()
boolean	isRecurring()
boolean	isTimeInferred()
void	setDateInferred(boolean isDateInferred)
void	setFullText(String fullText)
void	setIsTimeInferred(boolean isTimeInferred)
void	setLine(int line)
void	setParseLocations(Map<String,List<ParseLocation>> parseLocations)
void	setPosition(int position)
void	setRecurring(boolean isRecurring)
void	setRecurringUntil(Date recurringUntil)
void	setSyntaxTree(org.antlr.runtime.tree.Tree syntaxTree)
void	setText(String text)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DateGroup

public DateGroup()

Method Detail

addDate

public void addDate(Date date)

Adds a date to this group

Parameters:

date -

getAbsolutePosition

public int getAbsolutePosition()

Returns:

The absolute position of this date group within fullText

getDates

public List<Date> getDates()

Returns:

The list of dates in this group

getFullText

public String getFullText()

Returns:

The fullText this date group was found within

getLine

public int getLine()

The line within the fullText this date group is found on

Returns:

getParseLocations

public Map<String,List<ParseLocation>> getParseLocations()

Returns:

A map of all matching parse rules to their locations for this group

getPosition

public int getPosition()

Returns:

The character position of the matching text within the line of fullText

getPrefix

public String getPrefix(int length)

Parameters:

length - The maximum number of characters to include

Returns:

The immediate prefix within fullText to this group's text within the fullText

getRecursUntil

public Date getRecursUntil()

Returns:

the end date of any recurrence found

getSuffix

public String getSuffix(int length)

Parameters:

length - The maximum number of characters to include

Returns:

The immediate suffix within fullText to this group's text within the fullText

getSyntaxTree

public org.antlr.runtime.tree.Tree getSyntaxTree()

Returns:

The abstract syntax tree built for this group

getText

public String getText()

Returns:

The text within fullText this group represents

isDateInferred

public boolean isDateInferred()

Returns:

true if the date information in this group has been inferred, as opposed to being explicitly defined in the input

isRecurring

public boolean isRecurring()

Returns:

true if some recurrence information was found

isTimeInferred

public boolean isTimeInferred()

Returns:

true if the time information in this group has been inferred, as opposed to being explicitly defined in the input

setDateInferred

public void setDateInferred(boolean isDateInferred)

setFullText

public void setFullText(String fullText)

setIsTimeInferred

public void setIsTimeInferred(boolean isTimeInferred)

setLine

public void setLine(int line)

setParseLocations

public void setParseLocations(Map<String,List<ParseLocation>> parseLocations)

setPosition

public void setPosition(int position)

setRecurring

public void setRecurring(boolean isRecurring)

setRecurringUntil

public void setRecurringUntil(Date recurringUntil)

setSyntaxTree

public void setSyntaxTree(org.antlr.runtime.tree.Tree syntaxTree)

setText

public void setText(String text)