Difference between revisions of "PubMan Func Spec Date Search"

From MPDLMediaWiki
Jump to navigation Jump to search
m (→‎Actors: typo)
 
(30 intermediate revisions by 2 users not shown)
Line 2: Line 2:


=Basic Rules=
=Basic Rules=
* Functional Specification on advanced search, indexing and search query syntax is specified here: [[PubMan_Func_Spec_Search| Functional Specification PubMan Search]]
* the start date always ...
* the start date always ...
:: has to be sooner than or
:: has to be sooner than or
Line 29: Line 31:
=Automatic Serializations=
=Automatic Serializations=
That paragraph describes how date entries which are made by PubMan users should always be handled on technical level.
That paragraph describes how date entries which are made by PubMan users should always be handled on technical level.


==Start Date==
==Start Date==
Line 34: Line 38:
* 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




Line 47: Line 47:
** 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 53:
* 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 end 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 end 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 date search usecases describe possible combinations of date searches via advanced search in PubMan. For all date search usecases the previously specified automatic serializations are true. The date format of start and end page of course don't have to be always equal - they could be combined, but the rules stay the same.
 
 


==Search for Time Ranges==
==Search for Time Ranges==


===UC_PM_DS_01_Search for dates in format YYYY===
===UC_PM_DS_01_Search for dates in format YYYY===
Line 79: Line 76:
====Status/Schedule====
====Status/Schedule====


Status: in specification
Status: in specification <br>
Schedule: R6.1
Schedule: R6.1


Line 87: Line 84:


====Actors====
====Actors====
* user (logged in as well es not logged in)
* user (logged in as well as not logged in)


====Flow of Events====
====Flow of Events====
Line 93: Line 90:
* 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 115: Line 96:
====Status/Schedule====
====Status/Schedule====


Status: in specification
Status: in specification <br>
Schedule: R6.1
Schedule: R6.1


Line 137: Line 118:
***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 <br>
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 < 31 -> the search result must not contain items which comprise dates in format YYYY-MM (at least for the respective year and month of the end date)
** dates in format YYYY for the special cases:
*** see UC_PM_DS_02_Search for dates in format YYYY-MM
**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




Line 167: Line 151:
== Search for a specific Date==
== Search for a specific Date==


'''example:'''
 
* the user searches for a specific date
 
* the enters for example:
===UC_PM_DS_04_Search for a specific date in format YYYY-MM-DD===
** 2009-08-18 as start date
 
** 2009-08-18 as end date
====Status/Schedule====
* the search result should contain all items with the exact date 2009-08-18
 
Status: in specification <br>
Schedule: R6.1
 
====Trigger====
 
* the user wants to search for a specific date
 
====Actors====
* user (logged in as well es not logged in)
 
====Flow of Events====
* the user enters the same date in format YYYY-MM-DD for start date as well as for end date
* the search result should contain all items which comprise the exact given date
 




==Search only in Start Date==
==Search only in Start Date==


'''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=
 
*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.
===UC_PM_DS_05_Search only in start date in format YYYY===
 
====Status/Schedule====
 
Status: in specification <br>
Schedule: R6.1
 
====Trigger====
 
* the user wants to search for publications which have a date in the past until those with recent dates
 
====Actors====
* user (logged in as well es not logged in)
 
====Flow of Events====
* the user enters a date in format YYYY in the start date
* the search result should contain all stored items which comprise dates in format YYYY as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD since the date which is given as start date in the query
** minimum date = YYYY-01-01; maximum = recent date of stored publications
 
 
 
===UC_PM_DS_06_Search only in start date in format YYYY-MM===
 
====Status/Schedule====
 
Status: in specification <br>
Schedule: R6.1
 
====Trigger====
 
* the user wants to search for publications which have a date in the past until those with recent dates
 
====Actors====
* user (logged in as well es not logged in)
 
====Flow of Events====
* the user enters a date in format YYYY-MM in the start date
* the search result should contain all stored items which comprise
** dates in format YYYY-MM
** dates in format YYYY-MM-DD since the date which is given as start date in the query
**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 for the respective year of the start date
 
 
 
===UC_PM_DS_07_Search only in start date in format YYYY-MM-DD===
 
====Status/Schedule====
 
Status: in specification <br>
Schedule: R6.1
 
====Trigger====
 
* the user wants to search for publications which have a specific date in the past until those with recent dates
 
====Actors====
* user (logged in as well es not logged in)
 
====Flow of Events====
* the user enters a date in format YYYY-MM-DD in the start date
* the search result should contain all stored items which comprise
** dates in format YYYY-MM-DD since the date which is given as start date in the query
** 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 for the respective year and month of the start date
** dates in format YYYY for the special cases:
*** see UC_PM_DS_06_Search only in start date in format YYYY-MM
 
 
 
=Simple Search=
*Single date search in format YYYY as well as in format YYYY-MM as well as in format YYYY-MM-DD should be handled the same way as for advanced search.

Latest revision as of 08:31, 3 March 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 end date is given in format YYYY-MM
    • it should always be handled as YYYY-MM-31


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


Date Search Usecases[edit]

The date search usecases describe possible combinations of date searches via advanced search in PubMan. For all date search usecases the previously specified automatic serializations are true. The date format of start and end page of course don't have to be always equal - they could be combined, but the rules stay the same.


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 as 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 < 31 -> the search result must not contain items which comprise dates in format YYYY-MM (at least for the respective year and month of the end date)
    • dates in format YYYY for the special cases:
      • see UC_PM_DS_02_Search for dates in format YYYY-MM
    • 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


Search for a specific Date[edit]

UC_PM_DS_04_Search for a specific date in format YYYY-MM-DD[edit]

Status/Schedule[edit]

Status: in specification
Schedule: R6.1

Trigger[edit]

  • the user wants to search for a specific date

Actors[edit]

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

Flow of Events[edit]

  • the user enters the same date in format YYYY-MM-DD for start date as well as for end date
  • the search result should contain all items which comprise the exact given date


Search only in Start Date[edit]

UC_PM_DS_05_Search only in start date in format YYYY[edit]

Status/Schedule[edit]

Status: in specification
Schedule: R6.1

Trigger[edit]

  • the user wants to search for publications which have a date in the past until those with recent dates

Actors[edit]

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

Flow of Events[edit]

  • the user enters a date in format YYYY in the start date
  • the search result should contain all stored items which comprise dates in format YYYY as well as dates in format YYYY-MM as well as dates in format YYYY-MM-DD since the date which is given as start date in the query
    • minimum date = YYYY-01-01; maximum = recent date of stored publications


UC_PM_DS_06_Search only in start date in format YYYY-MM[edit]

Status/Schedule[edit]

Status: in specification
Schedule: R6.1

Trigger[edit]

  • the user wants to search for publications which have a date in the past until those with recent dates

Actors[edit]

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

Flow of Events[edit]

  • the user enters a date in format YYYY-MM in the start date
  • the search result should contain all stored items which comprise
    • dates in format YYYY-MM
    • dates in format YYYY-MM-DD since the date which is given as start date in the query
    • 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 for the respective year of the start date


UC_PM_DS_07_Search only in start date in format YYYY-MM-DD[edit]

Status/Schedule[edit]

Status: in specification
Schedule: R6.1

Trigger[edit]

  • the user wants to search for publications which have a specific date in the past until those with recent dates

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 in the start date
  • the search result should contain all stored items which comprise
    • dates in format YYYY-MM-DD since the date which is given as start date in the query
    • 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 for the respective year and month of the start date
    • dates in format YYYY for the special cases:
      • see UC_PM_DS_06_Search only in start date in format YYYY-MM


Simple Search[edit]

  • Single date search in format YYYY as well as in format YYYY-MM as well as in format YYYY-MM-DD should be handled the same way as for advanced search.

Publication Management

Use Case

Directory Service

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