com.exalead.indexing.analysis.v10

Class FormatCheckerDate

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

com.exalead.indexing.analysis.v10.FormatCheckerDate

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class FormatCheckerDate
extends SingleContextDocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

The FormatCheckDate processor checks the chunk matches either:

• a custom input format defined with UNIX date syntax (for example,%Y/%m/%d-%H:%M:%S)
• one of the automatically recognized date formats

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

SingleContextDocumentProcessor.Transformer<T>

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

DocumentProcessor.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	inputFormat

Fields inherited from class com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

inputContext

Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

acceptCondition, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

Constructor and Description
FormatCheckerDate()
FormatCheckerDate(FormatCheckerDate o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
<T> T	accept(SingleContextDocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this FormatCheckerDate.
static FormatCheckerDate	fromString(java.lang.String s) String representation of this FormatCheckerDate.
java.lang.String	getInputFormat() An optional date input format, compliant with libc's strptime() format. If such a format is provided, the automatic date format heuristic is disabled, and the provided date format is used exclusively. Documentation of accepted formats: (days and month literals are only recognized in English) %a: The day of the week ("Monday", ...) %A: Equivalent to %a %b: The month ("January", ...) %B: Equivalent to %b %c: Equivalent to %a %b %e %H:%M:%S %Y %C: The century number [00,99] %d: The day of the month [01,31] %D: Equivalent to %m/%d/%y %e: Equivalent to %d %h: Equivalent to %b %H: The hour (24-hour clock) [00,23] %I: The hour (12-hour clock) [01,12] %j: The day number of the year [001,366] %m: The month number [01,12] %M: The minute [00,59] %n: Any white space %dt: AM or PM %r: Equivalent to %I:%M:%S %p %R: Equivalent to %H:%M %S: The seconds [00,60] %t: Any white space %T: Equivalent to %H:%M:%S %U: The week number of the year (Sunday as the first day of the week) as a decimal number [00,53] %w: The weekday as a decimal number [0,6], with 0 representing Sunday %W: The week number of the year (Monday as the first day of the week) as a decimal number [00,53] %x: Equivalent to %m/%d/%y %X: Equivalent to %H:%M:%S %y: The year within century.
FormatCheckerDate	makeCopy() Creates and returns a deep copy of this FormatCheckerDate.
static FormatCheckerDate	readFrom(java.io.InputStream is) Read this FormatCheckerDate from an XML fragment.
void	setInputFormat(java.lang.String inputFormat) An optional date input format, compliant with libc's strptime() format. If such a format is provided, the automatic date format heuristic is disabled, and the provided date format is used exclusively. Documentation of accepted formats: (days and month literals are only recognized in English) %a: The day of the week ("Monday", ...) %A: Equivalent to %a %b: The month ("January", ...) %B: Equivalent to %b %c: Equivalent to %a %b %e %H:%M:%S %Y %C: The century number [00,99] %d: The day of the month [01,31] %D: Equivalent to %m/%d/%y %e: Equivalent to %d %h: Equivalent to %b %H: The hour (24-hour clock) [00,23] %I: The hour (12-hour clock) [01,12] %j: The day number of the year [001,366] %m: The month number [01,12] %M: The minute [00,59] %n: Any white space %dt: AM or PM %r: Equivalent to %I:%M:%S %p %R: Equivalent to %H:%M %S: The seconds [00,60] %t: Any white space %T: Equivalent to %H:%M:%S %U: The week number of the year (Sunday as the first day of the week) as a decimal number [00,53] %w: The weekday as a decimal number [0,6], with 0 representing Sunday %W: The week number of the year (Monday as the first day of the week) as a decimal number [00,53] %x: Equivalent to %m/%d/%y %X: Equivalent to %H:%M:%S %y: The year within century.
java.lang.String	toString() String representation of this FormatCheckerDate.
FormatCheckerDate	withAcceptCondition(AcceptCondition acceptCondition)
FormatCheckerDate	withDataModelClass(java.lang.String dataModelClass)
FormatCheckerDate	withDataModelProperty(java.lang.String dataModelProperty)
FormatCheckerDate	withDataModelState(java.lang.String dataModelState)
FormatCheckerDate	withDisabled(boolean disabled)
FormatCheckerDate	withDisabled(java.lang.Boolean disabled)
FormatCheckerDate	withFromDataModel(DocumentProcessor fromDataModel)
FormatCheckerDate	withInputContext(java.lang.String inputContext)
FormatCheckerDate	withInputFormat(java.lang.String inputFormat)
FormatCheckerDate	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this FormatCheckerDate as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

getInputContext, setInputContext

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

getAcceptCondition, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setAcceptCondition, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

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

Field Detail

inputFormat

public java.lang.String inputFormat

Constructor Detail

FormatCheckerDate

public FormatCheckerDate()

FormatCheckerDate

public FormatCheckerDate(FormatCheckerDate o)

Copy constructor

Method Detail

withInputContext

public FormatCheckerDate withInputContext(java.lang.String inputContext)

Overrides:

withInputContext in class SingleContextDocumentProcessor

withAcceptCondition

public FormatCheckerDate withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class SingleContextDocumentProcessor

withName

public FormatCheckerDate withName(java.lang.String name)

Overrides:

withName in class SingleContextDocumentProcessor

withDataModelState

public FormatCheckerDate withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SingleContextDocumentProcessor

withFromDataModel

public FormatCheckerDate withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class SingleContextDocumentProcessor

withDataModelClass

public FormatCheckerDate withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SingleContextDocumentProcessor

withDataModelProperty

public FormatCheckerDate withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SingleContextDocumentProcessor

withDisabled

public FormatCheckerDate withDisabled(boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

withDisabled

public FormatCheckerDate withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

setInputFormat

public void setInputFormat(java.lang.String inputFormat)

An optional date input format, compliant with libc's strptime() format.
If such a format is provided, the automatic date format heuristic is disabled, and the provided date format is used exclusively.
Documentation of accepted formats: (days and month literals are only recognized in English)

• %a: The day of the week ("Monday", ...)
• %A: Equivalent to %a
• %b: The month ("January", ...)
• %B: Equivalent to %b
• %c: Equivalent to %a %b %e %H:%M:%S %Y
• %C: The century number [00,99]
• %d: The day of the month [01,31]
• %D: Equivalent to %m/%d/%y
• %e: Equivalent to %d
• %h: Equivalent to %b
• %H: The hour (24-hour clock) [00,23]
• %I: The hour (12-hour clock) [01,12]
• %j: The day number of the year [001,366]
• %m: The month number [01,12]
• %M: The minute [00,59]
• %n: Any white space
• %dt: AM or PM
• %r: Equivalent to %I:%M:%S %p
• %R: Equivalent to %H:%M
• %S: The seconds [00,60]
• %t: Any white space
• %T: Equivalent to %H:%M:%S
• %U: The week number of the year (Sunday as the first day of the week) as a decimal number [00,53]
• %w: The weekday as a decimal number [0,6], with 0 representing Sunday
• %W: The week number of the year (Monday as the first day of the week) as a decimal number [00,53]
• %x: Equivalent to %m/%d/%y
• %X: Equivalent to %H:%M:%S
• %y: The year within century. (for two-digit dates, [69,99] is mapped to [1969,1999] and [00,68] is mapped to [2000,2068])
• %Y: The year, including the century (for example, 1988)
• %%: Replaced by %

getInputFormat

public java.lang.String getInputFormat()

An optional date input format, compliant with libc's strptime() format.
If such a format is provided, the automatic date format heuristic is disabled, and the provided date format is used exclusively.
Documentation of accepted formats: (days and month literals are only recognized in English)

• %a: The day of the week ("Monday", ...)
• %A: Equivalent to %a
• %b: The month ("January", ...)
• %B: Equivalent to %b
• %c: Equivalent to %a %b %e %H:%M:%S %Y
• %C: The century number [00,99]
• %d: The day of the month [01,31]
• %D: Equivalent to %m/%d/%y
• %e: Equivalent to %d
• %h: Equivalent to %b
• %H: The hour (24-hour clock) [00,23]
• %I: The hour (12-hour clock) [01,12]
• %j: The day number of the year [001,366]
• %m: The month number [01,12]
• %M: The minute [00,59]
• %n: Any white space
• %dt: AM or PM
• %r: Equivalent to %I:%M:%S %p
• %R: Equivalent to %H:%M
• %S: The seconds [00,60]
• %t: Any white space
• %T: Equivalent to %H:%M:%S
• %U: The week number of the year (Sunday as the first day of the week) as a decimal number [00,53]
• %w: The weekday as a decimal number [0,6], with 0 representing Sunday
• %W: The week number of the year (Monday as the first day of the week) as a decimal number [00,53]
• %x: Equivalent to %m/%d/%y
• %X: Equivalent to %H:%M:%S
• %y: The year within century. (for two-digit dates, [69,99] is mapped to [1969,1999] and [00,68] is mapped to [2000,2068])
• %Y: The year, including the century (for example, 1988)
• %%: Replaced by %

withInputFormat

public FormatCheckerDate withInputFormat(java.lang.String inputFormat)

makeCopy

public FormatCheckerDate makeCopy()

Creates and returns a deep copy of this FormatCheckerDate.

Overrides:

makeCopy in class SingleContextDocumentProcessor

readFrom

public static FormatCheckerDate readFrom(java.io.InputStream is)
                                  throws javax.xml.bind.JAXBException

Read this FormatCheckerDate from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this FormatCheckerDate as an XML fragment

Overrides:

writeTo in class SingleContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static FormatCheckerDate fromString(java.lang.String s)
                                    throws javax.xml.bind.JAXBException,
                                           java.io.UnsupportedEncodingException

String representation of this FormatCheckerDate.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FormatCheckerDate.

Overrides:

toString in class SingleContextDocumentProcessor

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this FormatCheckerDate.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SingleContextDocumentProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(SingleContextDocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class SingleContextDocumentProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(DocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class DocumentProcessor

Throws:

com.exalead.util.TypedException