prefuse.data.parser

Class DateParser

java.lang.Object

prefuse.data.parser.DateParser

All Implemented Interfaces:

DataParser

Direct Known Subclasses:

DateTimeParser, TimeParser

public class DateParser
extends java.lang.Object
implements DataParser

DataParser instance that parses Date values as java.sql.Time instances, representing a particular date (but not a specific time on that day). This class uses a backing DateFormat instance to perform parsing. The DateFormat instance to use can be passed in to the constructor, or by default the DateFormat returned by DateFormat.getDateInstance(int) with an argument of DateFormat.SHORT is used.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.text.DateFormat	m_dfmt
protected java.text.ParsePosition	m_pos

Constructor Summary

Constructors

Constructor and Description
DateParser() Create a new DateParser.
DateParser(java.text.DateFormat dateFormat) Create a new DateParser.

Method Summary

Modifier and Type	Method and Description
boolean	canParse(java.lang.String text) Indicates if the given text string can be successfully parsed by this parser.
java.lang.String	format(java.lang.Object value) Get a String representation for the given value.
java.lang.Class	getType() Returns java.sql.Date.
java.lang.Object	parse(java.lang.String text) Parse the given text string to a data value.
java.sql.Date	parseDate(java.lang.String text) Parse a Date value from a text string.

Methods inherited from class java.lang.Object

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

Field Detail

m_dfmt

protected java.text.DateFormat m_dfmt

m_pos

protected java.text.ParsePosition m_pos

Constructor Detail

DateParser

public DateParser()

Create a new DateParser.

DateParser

public DateParser(java.text.DateFormat dateFormat)

Create a new DateParser.

Parameters:

dateFormat - the DateFormat instance to use for parsing

Method Detail

getType

public java.lang.Class getType()

Returns java.sql.Date.

Specified by:

getType in interface DataParser

Returns:

the parsed data type for this parser as a Java Class instance

See Also:

DataParser.getType()

format

public java.lang.String format(java.lang.Object value)

Description copied from interface: DataParser

Get a String representation for the given value.

Specified by:

format in interface DataParser

Parameters:

value - the object value to format

Returns:

a formatted String representing the input value

See Also:

DataParser.format(java.lang.Object)

canParse

public boolean canParse(java.lang.String text)

Description copied from interface: DataParser

Indicates if the given text string can be successfully parsed by this parser.

Specified by:

canParse in interface DataParser

Parameters:

text - the text string to check for parsability

Returns:

true if the string can be successfully parsed into this parser's data type, false otherwise

See Also:

DataParser.canParse(java.lang.String)

parse

public java.lang.Object parse(java.lang.String text)
                       throws DataParseException

Description copied from interface: DataParser

Parse the given text string to a data value.

Specified by:

parse in interface DataParser

Parameters:

text - the text string to parse

Returns:

the parsed data value, which will be an instance of the Class returned by the DataParser.getType() method

Throws:

DataParseException - if an error occurs during parsing

See Also:

DataParser.parse(java.lang.String)

parseDate

public java.sql.Date parseDate(java.lang.String text)
                        throws DataParseException

Parse a Date value from a text string.

Parameters:

text - the text string to parse

Returns:

the parsed Date value

Throws:

DataParseException - if an error occurs during parsing