XML Configuration Reference : Index : DateFormatter
 
DateFormatter
• com.exalead.indexing.analysis.v10.DateFormatter
• If a document 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 (click icon for more information)
the Date Formatter generates three additional document chunks, each with its own context name, using the following naming convention:
◦ $inputContext$dateTimeOutputContext (Default format: %Y/%m/%d-%H:%M:%S)
◦ $inputContext$dateOutputContext (Default format: %Y/%m/%d)
◦ $inputContext$timeOutputContext (Default format: %H:%M:%S)
@csh AC_DATE_FORMATTER_ID
• Parent elements:
◦ com.exalead.indexing.analysis.v10.AnalysisPipeline (as AnalysisPipeline)
◦ com.exalead.indexing.analysis.v10.DocumentProcessorGroup (as DocumentProcessorGroup)
• Attributes:
Name
Type
Default value
Description
inputContext
string
The processor will only be applied to DocumentChunks with this ContextName.
name
string
Name of this processor. The name of a processor is used only for tracing and debugging purposes.
dataModelState
string
Is this document processor managed by a data model? @enum{null,auto,customized, error}.
• If null, this document processor is not related to a data model.
• If "auto", this document processor is auto-generated by a data model.
• If "customized", this document processor was auto-generated by a data model and then customized.
• If "error", there is a conflict between this document processor and the data model.
dataModelClass
string
If dataModelState is either "auto" or "customized", you will find here the name of the DataModelClass that generated this DocumentProcessor.
dataModelProperty
string
If dataModelState is either "auto" or "customized", you will find here the name of the DataModelProperty that generated this DocumentProcessor.
disabled
boolean
Disable the DocumentProcessor
dateTimeOutputContext
string
Suffix for the name of the DocumentChunk containing the date as defined by dateTimeOutputFormat (default YYYY/MM/DD-HH:MM:SS). The original ContextName of the input DocumentChunk and this suffix are concatenated ($orig$dateTimeOutputContext) to produce the ContextName actually used. This DocumentChunk is usually used for date display.
dateTimeOutputFormat
string
A date and time output format compliant with libc's strftime.
dateOutputContext
string
Suffix for the name of the DocumentChunk containing the date as defined by dateOutputFormat (default YYYY/MM/DD). The original name of the input DocumentChunk and this suffix are concatenated ($orig$dateTimeOutputContext) to produce the name actually used. This DocumentChunk is usually remapped to a category for navigation.
dateOutputFormat
string
A date output format compliant with libc's strftime.
timeOutputContext
string
Suffix for the name of the DocumentChunk containing the date as defined by timeOutputFormat (default HH:MM:SS). The original name of the input DocumentChunk and this suffix are concatenated ($orig$dateTimeOutputContext) to produce the name actually used.
timeOutputFormat
string
A time output format compliant with libc's strftime.
inputFormat
string
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)
• Day
◦ %a: weekday abbreviated ("Mon", ...)
◦ %A: weekday full ("Monday", ...)
◦ %d: day of the month, zero filled [01-31]
◦ %e: Equivalent to %d [1-31]
◦ %j: day year, zero filled [001-366]
◦ %u: day of week starting with Monday (1), i.e. mtwtfss [7 (for Sunday)]
◦ %w: day of week as a decimal number [0,6], with 0 representing Sunday
• Week
◦ %U: week number of the year (Sunday as first day of the week) as a decimal number [00,53]
◦ %W: week number of the year (Monday as the first day of the week) as a decimal number [01,53]
◦ %V: week of the year [01-53]
• Month
◦ %m: the month number [01-12]
◦ %b: month locale abbreviated ("Aug", ...)
◦ %h: equivalent to %b
◦ %B: locale's full month, variable length ("August")
• Year
◦ %y: The year within the century with two-digit dates, for example [69,99] is mapped to [1969,1999] and [00,68] is mapped to [2000,2068]
◦ %Y: The year, including the century (for example, 2014)
◦ %g: last two digits of year of ISO week number (see %G)
◦ %G: year of ISO week number (see %V), for example, 2014; normally useful only with %V
• Century
◦ %C: The century number [00,99]
• Date
◦ %D: Equivalent to mm/dd/yy (08/20/14)
◦ %x: locale's date representation (mm/dd/yy), 08/20/2014
◦ %F: %Y-%m-%d (2014-08-20)
• Hours
◦ %l: hour (12-hour clock), for example, [1-12]
◦ %I: hour (12-hour clock) zero filled, [01-12]
◦ %k: hour (24 hour), for example, 17
◦ %H: hour (24 hour) zero padded, 17
◦ %p: locale's upper case AM or PM (blank in many locales), for example, PM
◦ %P: locale's lower case am or pm, for example, pm
• Minutes
◦ %M: The minute [00-59]
• Seconds
◦ %s: seconds since 00:00:00 1970-01-01 UTC (Unix epoch), for example, 1345483096
◦ %S: seconds [00-60], (The 60 is necessary to accommodate a leap second)
• Time
◦ %r: hours, minutes, seconds (12-hour clock), for example, 05:18:16 PM
◦ %R: hours, minutes (24-hour clock), for example, 17:18
◦ %T: hours, minutes, seconds (24-hour clock), for example, 17:18:16
◦ %X: locale's time representation, for example, 11:07:26 AM
◦ %dt: AM or PM
• Date and Time
◦ %c: locale's date and time, for example, Sat Nov 04 12:02:33 EST 1989
• Others
◦ %n: Any white space
◦ %t: Any white space
◦ %%: Replaced by %
removeOriginalChunk
boolean
True
Removes the original input chunk.
• Nested elements:
Name
Type
Description
fromDataModel
com.exalead.indexing.analysis.v10.DocumentProcessor
If dataModelState is "customized", you will find here the original document processor generated by the data model. Use this to easily revert to "auto" state from "customized". @IgnoreForValueConstructor
AcceptCondition
com.exalead.indexing.analysis.v10.AcceptCondition
Expresses the enablement condition of this DocumentProcessor.