BubbleCalendarData (OpenWayback 2.1.0 API)

java.lang.Object
- org.archive.wayback.partition.BubbleCalendarData

```
public class BubbleCalendarData
extends Object
```
Support bean for rendering capture calendar.
Despite name, this class is generally useful for different calendar styles.

Initialize with UIResults that is set up with CaptureSearchResults and WaybackRequest.

Caveat: Although fields are all public for historical reasons, please use getters for reading their values. Field access-level will be changed in the future.

Author:

brad

Field Summary

Fields
Modifier and Type	Field and Description
`long`	`dataEndMSSE`
`long`	`dataStartMSSE`
`Date`	`firstResultDate`
`String`	`firstResultReplayUrl`
`Date`	`lastResultDate`
`String`	`lastResultReplayUrl`
`List<Partition<Partition<CaptureSearchResult>>>`	`monthsByDay`
`long`	`numResults`
`UIResults`	`results`
`Date`	`searchEndDate`
`Date`	`searchStartDate`
`String`	`searchUrlForHTML`
`String`	`searchUrlForJS`
`int`	`yearNum`

Constructor Summary

Constructors
Constructor and Description

BubbleCalendarData()
default constructor for use in JSP.

BubbleCalendarData(UIResults results)

Constructors
Constructor and Description
`BubbleCalendarData()` default constructor for use in JSP.
`BubbleCalendarData(UIResults results)`

Method Summary

Methods
Modifier and Type	Method and Description
`List<List<Partition<CaptureSearchResult>>>`	`getCaptureCalendar()` return `CaptureSearchResult` partitions for the month grouped by week.
`long`	`getDataEndMSSE()`
`long`	`getDataStartMSSE()`
`Date`	`getFirstResultDate()`
`String`	`getFirstResultReplayUrl()`
`Date`	`getLastResultDate()`
`String`	`getLastResultReplayUrl()`
`Date`	`getMonthDate()`
`Partition<Partition<CaptureSearchResult>>`	`getMonthPartition()`
`List<Partition<Partition<CaptureSearchResult>>>`	`getMonthsByDay()`
`long`	`getNumResults()`
`String`	`getSearchUrlForHTML()`
`String`	`getSearchUrlForJS()`
`int`	`getThisYear()`
`static Calendar`	`getUTCCalendar()` Deprecated. 1.8.1, use `Calendar.getInstance(TimeZone.getTimeZone("UTC"))`.
`int`	`getYearNum()`
`String`	`getYearsGraphString(int imgWidth, int imgHeight)`
`protected void`	`init()`
`void`	`setMonth(int month)` Set month for `getCaptureCalendar()`
`void`	`setResults(UIResults results)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

results
```
public UIResults results
```

searchUrlForJS
```
public String searchUrlForJS
```

searchUrlForHTML
```
public String searchUrlForHTML
```

searchStartDate
```
public Date searchStartDate
```

searchEndDate
```
public Date searchEndDate
```

firstResultDate
```
public Date firstResultDate
```

lastResultDate
```
public Date lastResultDate
```

yearNum
```
public int yearNum
```

dataStartMSSE
```
public long dataStartMSSE
```

dataEndMSSE
```
public long dataEndMSSE
```

numResults
```
public long numResults
```

firstResultReplayUrl
```
public String firstResultReplayUrl
```

lastResultReplayUrl
```
public String lastResultReplayUrl
```

monthsByDay

public List<Partition<Partition<CaptureSearchResult>>> monthsByDay

Constructor Detail
- BubbleCalendarData
```
public BubbleCalendarData()
```
  default constructor for use in JSP. be sure to set UIResults.
- BubbleCalendarData
```
public BubbleCalendarData(UIResults results)
```

Method Detail

setResults

public void setResults(UIResults results)

init
```
protected void init()
```

getYearsGraphString

public String getYearsGraphString(int imgWidth,
                         int imgHeight)

getUTCCalendar
```
public static Calendar getUTCCalendar()
```
Deprecated. 1.8.1, use Calendar.getInstance(TimeZone.getTimeZone("UTC")).

Returns:
Calendar for UTC

getSearchUrlForJS
```
public String getSearchUrlForJS()
```

getSearchUrlForHTML
```
public String getSearchUrlForHTML()
```

getFirstResultDate
```
public Date getFirstResultDate()
```

getLastResultDate
```
public Date getLastResultDate()
```

getYearNum
```
public int getYearNum()
```

getDataStartMSSE
```
public long getDataStartMSSE()
```

getDataEndMSSE
```
public long getDataEndMSSE()
```

getNumResults
```
public long getNumResults()
```

getFirstResultReplayUrl

public String getFirstResultReplayUrl()

getLastResultReplayUrl

public String getLastResultReplayUrl()

getMonthsByDay

public List<Partition<Partition<CaptureSearchResult>>> getMonthsByDay()

getThisYear
```
public int getThisYear()
```

setMonth
```
public void setMonth(int month)
```
Set month for getCaptureCalendar()

Parameters:
month - integer 0 (January) through 11 (December)

getMonthPartition

public Partition<Partition<CaptureSearchResult>> getMonthPartition()

getMonthDate
```
public Date getMonthDate()
```
Returns:
beginning of the month as Date for month

getCaptureCalendar
```
public List<List<Partition<CaptureSearchResult>>> getCaptureCalendar()
```
return CaptureSearchResult partitions for the month grouped by week. Call this method after designating desired month with setMonth(int). Each week group has exactly seven elements, where out-of-month slots are null.

Returns:
Weekly list of Partitions

Throws:

IllegalStateException - if month is not in 0..11 range.

Class BubbleCalendarData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

results

searchUrlForJS

searchUrlForHTML

searchStartDate

searchEndDate

firstResultDate

lastResultDate

yearNum

dataStartMSSE

dataEndMSSE

numResults

firstResultReplayUrl

lastResultReplayUrl

monthsByDay

Constructor Detail

BubbleCalendarData

BubbleCalendarData

Method Detail

setResults

init

getYearsGraphString

getUTCCalendar

getSearchUrlForJS

getSearchUrlForHTML

getFirstResultDate

getLastResultDate

getYearNum

getDataStartMSSE

getDataEndMSSE

getNumResults

getFirstResultReplayUrl

getLastResultReplayUrl

getMonthsByDay

getThisYear

setMonth

getMonthPartition

getMonthDate

getCaptureCalendar