Difference between revisions of "PubMan Func Spec Date Search"

From MPDLMediaWiki
Jump to navigation Jump to search
Line 34: Line 34:
* if the start date is given in format '''YYYY'''
* if the start date is given in format '''YYYY'''
** it should always be handled as '''YYYY-01-01'''
** it should always be handled as '''YYYY-01-01'''
* the search results should contain items which comprise dates in format YYYY as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD




* if the start date is given in format '''YYYY-MM'''
* if the start date is given in format '''YYYY-MM'''
** it should always be handled as '''YYYY-MM-01'''
** it should always be handled as '''YYYY-MM-01'''
* the search result should contain items which comprise dates in format YYYY-MM as well as dates in format YYYY-MM-DD




* if the start date is given in format '''YYYY-MM-DD'''
* if the start date is given in format '''YYYY-MM-DD'''
** it should always be handled as '''YYYY-MM-DD'''
** it should always be handled as '''YYYY-MM-DD'''
* the search results should contain items which comprise dates in format YYYY-MM-DD




Line 54: Line 48:
* if the end date is given in format '''YYYY'''
* if the end date is given in format '''YYYY'''
** it should always be handled as '''YYYY-12-31'''
** it should always be handled as '''YYYY-12-31'''
* the search results should contain items which comprise dates in format YYYY as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD




* if start date is given in format '''YYYY-MM'''
* if start date is given in format '''YYYY-MM'''
** it should always be handled as '''YYYY-MM-31'''
** it should always be handled as '''YYYY-MM-31'''
* the search result should contain items which comprise dates in format YYYY-MM as well as dates in format YYYY-MM-DD




* if the start date is given in format '''YYYY-MM-DD'''
* if the start date is given in format '''YYYY-MM-DD'''
** it should always be handled as '''YYYY-MM-DD'''
** it should always be handled as '''YYYY-MM-DD'''
* the search results should contain items which comprise dates in format YYYY-MM-DD




=Date Search Usecases=
=Date Search Usecases=
The search query usecases describe possible combinations of date searches via advanced search in PubMan. For all search query usecases the previously specified automatic serializations are true.
The search query usecases describe possible combinations of date searches via advanced search in PubMan. For all search query usecases the previously specified automatic serializations are true.


==Search for Time Ranges==
==Search for Time Ranges==
Line 93: Line 82:
* the search result should contain items which comprise dates in format YYYY as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD
* the search result should contain items which comprise dates in format YYYY as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD
   
   
====1st example:=====
* the user wants to search for a time range
* the users entries for example:
** 2005 as start date
** 2007 as end date
* the search result should contain items which comprise dates from 2005-01-01 (minimum) until 2007-12-31 (maximum)
* the dates within the items could either be in format YYYY or YYYY-MM or YYYY-MM-DD
====2nd example:====
* the user wants to query all publication of one year
* the user entries for example:
** 2009 as start date
** 2009 as end date
* the search result should contain all items of the respective year (publications from 2009-01-01 until 2009-12-31) which comprise dates either in format YYYY or YYYY-MM or YYYY-MM-DD




Line 137: Line 110:
***for all searched years between the given start year and the given end year the search result should contain all items which comprise dates in format YYYY as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD
***for all searched years between the given start year and the given end year the search result should contain all items which comprise dates in format YYYY as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD


====1st example====
* the user wants to search for a time range
* the users entries for example:
** 2005-03 as start date
** 2007-12 as end date
* the search result should contain all items which comprise:
**dates from 2005-03-01 (minimum) until 2007-12-31 (maximum)
* the search result must not contain items which comprise dates where just the year 2005 is given
* the search result should contain all items which comprise just the year 2006 or 2007 as well as all items which comprise dates in format YYYY-MM as well as dates in format YYYY-MM-DD


====2nd example====
* the user wants to search for a time range
* the users entries for example:
** 2008-01 as start date
** 2009-09 as end date
* the search result should contain all items which comprise:
**dates from 2008-01-01 (minimum) until 2009-19-31 (maximum)
* the search result should contain all items which comprise dates where just the year 2008 is given as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD
* the search result must not contain items which comprise dates where just the year 2009 is given


===UC_PM_DS_03_Search for dates in format YYYY-MM-DD===


====Status/Schedule====


Status: in specification
Schedule: R6.1


====Trigger====


* the user wants to search for a time range


====Actors====
* user (logged in as well es not logged in)
====Flow of Events====
* the user enters a date in format YYYY-MM-DD for start date as well as for end date
* the search result should contain items which comprise:
** dates in format YYYY-MM-DD
** dates in format YYYY-MM for that special cases:
*** if DD of start date = 01 -> the search result should contain all items which comprise dates in format YYYY-MM
*** if DD of start date > 01 -> the search result must not contain items which comprise dates in format YYYY-MM (at least for the respective year and month of the start date)
*** if DD of end date = 31 -> the search result should contain all items which comprise dates in format YYYY-DD
*** if MM of end date < 30/31 -> the search result must not contain items which comprise dates in format YYYY (at least for the respective year and month of the end date)
***for all searched years between the given start year and the given end year the search result should contain all items which comprise dates in format YYYY as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD
** dates in format YYY for the special cases:
*** see UC_PM_DS_02_Search for dates in format YYYY-MM




Revision as of 21:22, 25 February 2010


Basic Rules[edit]

  • the start date always ...
has to be sooner than or
has to be equal in time to
... the end date.

=> start date ≤ end date


  • the end date always ...
has to be later than or
has to be equal in time to
the start date.

=> end date ≥ start date


  • when the user is searching for time ranges ...
the start date is always the minimum and
the end date is always the maximum
... of the time range.

=> start date {minumum} ≤ set of search results ≤ end date {maximum}


Automatic Serializations[edit]

That paragraph describes how date entries which are made by PubMan users should always be handled on technical level.

Start Date[edit]

  • if the start date is given in format YYYY
    • it should always be handled as YYYY-01-01


  • if the start date is given in format YYYY-MM
    • it should always be handled as YYYY-MM-01


  • if the start date is given in format YYYY-MM-DD
    • it should always be handled as YYYY-MM-DD


End Date[edit]

  • if the end date is given in format YYYY
    • it should always be handled as YYYY-12-31


  • if start date is given in format YYYY-MM
    • it should always be handled as YYYY-MM-31


  • if the start date is given in format YYYY-MM-DD
    • it should always be handled as YYYY-MM-DD


Date Search Usecases[edit]

The search query usecases describe possible combinations of date searches via advanced search in PubMan. For all search query usecases the previously specified automatic serializations are true.


Search for Time Ranges[edit]

UC_PM_DS_01_Search for dates in format YYYY[edit]

Status/Schedule[edit]

Status: in specification Schedule: R6.1

Trigger[edit]

  • the user wants to search for a time range

Actors[edit]

  • user (logged in as well es not logged in)

Flow of Events[edit]

  • the user enters a date in format YYYY for start date as well as for end date
  • the search result should contain items which comprise dates in format YYYY as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD


UC_PM_DS_02_Search for dates in format YYYY-MM[edit]

Status/Schedule[edit]

Status: in specification Schedule: R6.1

Trigger[edit]

  • the user wants to search for a time range

Actors[edit]

  • user (logged in as well es not logged in)

Flow of Events[edit]

  • the user enters a date in format YYYY-MM for start date as well as for end date
  • the search result should contain items which comprise:
    • dates in format YYYY-MM
    • dates in format YYYY-MM-DD
    • dates in format YYYY for that special cases:
      • if MM of start date = 01 -> the search result should contain all items which comprise dates in format YYYY
      • if MM of start date > 01 -> the search result must not contain items which comprise dates in format YYYY (at least for the respective year of the start date)
      • if MM of end date = 12 -> the search result should contain all items which comprise dates in format YYYY
      • if MM of end date < 12 -> the search result must not contain items which comprise dates in format YYYY (at least for the respective year of the end date)
      • for all searched years between the given start year and the given end year the search result should contain all items which comprise dates in format YYYY as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD


UC_PM_DS_03_Search for dates in format YYYY-MM-DD[edit]

Status/Schedule[edit]

Status: in specification Schedule: R6.1

Trigger[edit]

  • the user wants to search for a time range

Actors[edit]

  • user (logged in as well es not logged in)

Flow of Events[edit]

  • the user enters a date in format YYYY-MM-DD for start date as well as for end date
  • the search result should contain items which comprise:
    • dates in format YYYY-MM-DD
    • dates in format YYYY-MM for that special cases:
      • if DD of start date = 01 -> the search result should contain all items which comprise dates in format YYYY-MM
      • if DD of start date > 01 -> the search result must not contain items which comprise dates in format YYYY-MM (at least for the respective year and month of the start date)
      • if DD of end date = 31 -> the search result should contain all items which comprise dates in format YYYY-DD
      • if MM of end date < 30/31 -> the search result must not contain items which comprise dates in format YYYY (at least for the respective year and month of the end date)
      • for all searched years between the given start year and the given end year the search result should contain all items which comprise dates in format YYYY as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD
    • dates in format YYY for the special cases:
      • see UC_PM_DS_02_Search for dates in format YYYY-MM


Search for a specific Date[edit]

example:

  • the user searches for a specific date
  • the enters for example:
    • 2009-08-18 as start date
    • 2009-08-18 as end date
  • the search result should contain all items with the exact date 2009-08-18


Search only in Start Date[edit]

example:

  • the user enters a date only in the field for the start date
  • the user enters for example:
  • 2005-02-17 as start date
  • the search result should contain all items which comprise a date of minimum 2005-02-17 and a maximum date, which is the recent date of all publications (= all stored publications with a date since 2005-02-17)

Comment[edit]

  • I will list and explain all search query types for dates with an example in the PubMan help; so the user is able to understand what search result has to be expected.

Publication Management

Use Case

Directory Service

Retrieved from "https://colab.mpdl.mpg.de/mw010/index.php?title=PubMan_Func_Spec_Date_Search&oldid=49488"