Java Doc for DateMathParser.java in  » Search-Engine » compass-2.0 » org » compass » core » converter » basic » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Search Engine » compass 2.0 » org.compass.core.converter.basic 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.compass.core.converter.basic.DateMathParser

DateMathParser
public class DateMathParser (Code)
A Simple Utility class for parsing "math" like strings relating to Dates.

The basic syntax support addition, subtraction and rounding at various levels of granularity (or "units"). Commands can be chained together and are parsed from left to right. '+' and '-' denote addition and subtraction, while '/' denotes "round". Round requires only a unit, while addition/subtraction require an integer value and a unit. Command strings must not include white space, but the "No-Op" command (empty string) is allowed....

 /HOUR
 ... Round to the start of the current hour
 /DAY
 ... Round to the start of the current day
 +2YEARS
 ... Exactly two years in the future from now
 -1DAY
 ... Exactly 1 day prior to now
 /DAY+6MONTHS+3DAYS
 ... 6 months and 3 days in the future from the start of
 the current day
 +6MONTHS+3DAYS/DAY
 ... 6 months and 3 days in the future from now, rounded
 down to nearest day
 

All commands are relative to a "now" which is fixed in an instance of DateMathParser such that p.parseMath("+0MILLISECOND").equals(p.parseMath("+0MILLISECOND")) no matter how many wall clock milliseconds elapse between the two distinct calls to parse (Assuming no other thread calls "setNow" in the interim)

Multiple aliases exist for the various units of time (ie: MINUTE and MINUTES; MILLI, MILLIS, MILLISECOND, and MILLISECONDS.) The complete list can be found by inspecting the keySet of CALENDAR_UNITS.


author:
   taken from Solr


Field Summary
final public static  MapCALENDAR_UNITS
     A mapping from (uppercased) String labels idenyifying time units, to the corresponding Calendar constant used to set/add/roll that unit of measurement.

Constructor Summary
public  DateMathParser(TimeZone tz, Locale l)
    

Method Summary
public static  voidadd(Calendar c, int val, String unit)
    
public  DategetNow()
    
public  DateparseMath(String math)
     Parses a string of commands relative "now" are returns the resulting Date.
public static  voidround(Calendar c, String unit)
    
public  voidsetNow(Date n)
    

Field Detail
CALENDAR_UNITS
final public static Map CALENDAR_UNITS(Code)
A mapping from (uppercased) String labels idenyifying time units, to the corresponding Calendar constant used to set/add/roll that unit of measurement.

A single logical unit of time might be represented by multiple labels for convenience (ie: DATE==DAY, MILLI==MILLISECOND)


See Also:   java.util.Calendar




Constructor Detail
DateMathParser
public DateMathParser(TimeZone tz, Locale l)(Code)

Parameters:
  tz - The TimeZone used for rounding (to determine when hours/days begin)
Parameters:
  l - The Locale used for rounding (to determine when weeks begin)
See Also:   Calendar.getInstance(TimeZoneLocale)




Method Detail
add
public static void add(Calendar c, int val, String unit)(Code)
Modifies the specified Calendar by "adding" the specified value of units
throws:
  IllegalArgumentException - if unit isn't recognized.
See Also:   DateMathParser.CALENDAR_UNITS



getNow
public Date getNow()(Code)
Returns a cloned of this instance's concept of "now"



parseMath
public Date parseMath(String math) throws ParseException(Code)
Parses a string of commands relative "now" are returns the resulting Date.
throws:
  java.text.ParseException - positions in ParseExceptions are token positions, not character positions.



round
public static void round(Calendar c, String unit)(Code)
Modifies the specified Calendar by "rounding" down to the specified unit
throws:
  IllegalArgumentException - if unit isn't recognized.
See Also:   DateMathParser.CALENDAR_UNITS



setNow
public void setNow(Date n)(Code)
Redefines this instance's concept of "now"



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.