EventAnalysis

java.lang.Object
- unidue.ub.statistics.analysis.EventAnalysis

```
@Entity
public class EventAnalysis
extends java.lang.Object
```
Plain old java object holding an analysis of one year and one document. The fields can be persisted.

Version:

1

Author:

Eike Spielberg

Constructor Summary

Constructors
Constructor and Description

EventAnalysis()
Builds a new instance of a EventAnalysis-object, setting the individual counters to 0 and the text fields to an empty string.

Constructors
Constructor and Description
`EventAnalysis()` Builds a new instance of a `EventAnalysis`-object, setting the individual counters to 0 and the text fields to an empty string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnalysisToOutput(org.jdom2.Element parent)` adds the analysis org.jdom2.element to the desired parent element
`java.lang.String`	`getAuthor()` retrieves the author of the `StockControlProperties`
`java.lang.String`	`getCollection()` retrieves the collections to be analyzed (as list, separated with blanks)
`java.lang.String`	`getComment()` retrieves the comment of the analysis
`int`	`getDaysRequested()` retrieves the days items were requested throughout the period of analysis
`java.lang.String`	`getDescription()` retrieves the description of the analysis
`int`	`getLastStock()` retrieves the number of items at the end of the analysis period
`java.lang.String`	`getMab()` retrieves the bibliographic data
`java.lang.String`	`getMaterials()` retrieves the list of materials to be considered, each separated by blanks
`int`	`getMaxItemsNeeded()` retrieves the maximum number of items needed (stock and requests) throughout the period of analysis
`int`	`getMaxLoansAbs()` retrieves the maximum number of items loaned throughout the period of analysis
`int`	`getMaxNumberRequest()` retrieves the maximum number of items requested throughout the period of analysis
`double`	`getMaxRelativeLoan()` retrieves the maximum relative loan throughout the period of analysis
`double`	`getMeanRelativeLoan()` retrieves the mean relative loan of items in stock throughout the analysis
`double`	`getMeanStock()` retrieves the mean number of items in stock throughout the analysis
`int`	`getNumberRequests()` retrieves the number of requests throughout the period of analysis
`int`	`getProposedDeletion()` retrieves the number of proposed deletions
`int`	`getProposedPurchase()` retrieves the number of proposed purchases
`java.lang.String`	`getShelfmark()` retrieves the shelfmark where the analysis has been performed
`java.lang.String`	`getShelfmarkBase()` retrieve the basic shelfmark without the edition information
`double`	`getSlope()` retrieves the slope of the relative loan throughout the analysis
`java.lang.String`	`getStockcontrol()` retrieves the description of the `StockControlProperties` used for the analysis
`java.lang.String`	`getSystemCode()` retrieves the notation where the analysis has been performed
`double`	`getTimestamp()` retrieves the timestamp when the analysis has been performed
`void`	`increaseNumberRequests()` increases the number of requests
`void`	`setAuthor(java.lang.String author)` set the author of the `StockControlProperties`
`void`	`setCollection(java.lang.String collection)` set the collections to be analyzed (as list, separated with blanks)
`void`	`setComment(java.lang.String comment)` set the comment of the analysis
`void`	`setDaysRequested(int daysRequested)` set the days items were requested throughout the period of analysis
`void`	`setDescription(java.lang.String description)` set the description of the analysis
`void`	`setLastStock(int lastStock)` set the number of items at the end of the analysis period
`void`	`setMab(java.lang.String mab)` set the bibliographic data
`void`	`setMaterials(java.lang.String materials)` set the list of materials to be considered, each separated by blanks
`void`	`setMaxItemsNeeded(int maxItemsNeeded)` set the maximum number of items needed (stock and requests) throughout the period of analysis
`void`	`setMaxLoansAbs(int maxLoansAbs)` set the maximum number of items loaned throughout the period of analysis
`void`	`setMaxNumberRequest(int maxNumberRequest)` set the maximum number of items requested throughout the period of analysis
`void`	`setMaxRelativeLoan(double maxRelativeLoan)` set the maximum relative loan throughout the period of analysis
`void`	`setMeanRelativeLoan(double meanRelativeLoan)` set the mean relative loan throughout the period of analysis
`void`	`setMeanStock(double meanStock)` set the mean stock throughout the period of analysis
`void`	`setNumberRequests(int numberRequests)` set the number of requests throughout the period of analysis
`void`	`setProposedDeletion(int newProposedDeletion)` set the number of items proposed to be deleted
`void`	`setProposedPurchase(int proposedPurchase)` set the number of proposed purchases
`void`	`setShelfmark(java.lang.String shelfmark)` set the shelfmark where the analysis has been performed
`void`	`setShelfmarkBase(java.lang.String shelfmarkBase)` set the basic shelfmark without the edition information
`void`	`setSlope(double slope)` set the slope of the relative loan throughout the analysis
`void`	`setStockcontrol(java.lang.String stockControl)` set the description of the `StockControlProperties` used for the analysis
`void`	`setSystemCode(java.lang.String systemCode)` set the notation where the analysis has been performed
`void`	`setTimestamp(double timestamp)` set the timestamp when the analysis has been performed

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

- Constructor Detail
  - EventAnalysis
```
public EventAnalysis()
```
    Builds a new instance of a EventAnalysis-object, setting the individual counters to 0 and the text fields to an empty string.
- Method Detail
  - getAuthor
```
public java.lang.String getAuthor()
```
    retrieves the author of the StockControlProperties
    
    Returns:
    
    author of the StockControlProperties
  - setAuthor
```
public void setAuthor(java.lang.String author)
```
    set the author of the StockControlProperties
    
    Parameters:
    
    author - the author of the StockControlProperties
  - getStockcontrol
```
public java.lang.String getStockcontrol()
```
    retrieves the description of the StockControlProperties used for the analysis
    
    Returns:
    
    stockControl description of the StockControlProperties
  - setStockcontrol
```
public void setStockcontrol(java.lang.String stockControl)
```
    set the description of the StockControlProperties used for the analysis
    
    Parameters:
    
    stockControl - description of the StockControlProperties
  - getShelfmark
```
public java.lang.String getShelfmark()
```
    retrieves the shelfmark where the analysis has been performed
    
    Returns:
    
    shelfmark shelfmark
  - setShelfmark
```
public void setShelfmark(java.lang.String shelfmark)
```
    set the shelfmark where the analysis has been performed
    
    Parameters:
    
    shelfmark - shelfmark
  - getSystemCode
```
public java.lang.String getSystemCode()
```
    retrieves the notation where the analysis has been performed
    
    Returns:
    
    systemCode notation
  - setSystemCode
```
public void setSystemCode(java.lang.String systemCode)
```
    set the notation where the analysis has been performed
    
    Parameters:
    
    systemCode - notation
  - getCollection
```
public java.lang.String getCollection()
```
    retrieves the collections to be analyzed (as list, separated with blanks)
    
    Returns:
    
    collection list of collections (separated by blanks)
  - setCollection
```
public void setCollection(java.lang.String collection)
```
    set the collections to be analyzed (as list, separated with blanks)
    
    Parameters:
    
    collection - list of collections (separated by blanks)
  - getMaterials
```
public java.lang.String getMaterials()
```
    retrieves the list of materials to be considered, each separated by blanks
    
    Returns:
    
    materials list of materials to be considered
  - setMaterials
```
public void setMaterials(java.lang.String materials)
```
    set the list of materials to be considered, each separated by blanks
    
    Parameters:
    
    materials - list of materials to be considered
  - getTimestamp
```
public double getTimestamp()
```
    retrieves the timestamp when the analysis has been performed
    
    Returns:
    
    timestamp timestamp
  - setTimestamp
```
public void setTimestamp(double timestamp)
```
    set the timestamp when the analysis has been performed
    
    Parameters:
    
    timestamp - timestamp
  - getMab
```
public java.lang.String getMab()
```
    retrieves the bibliographic data
    
    Returns:
    
    mab bibliographic data
  - setMab
```
public void setMab(java.lang.String mab)
```
    set the bibliographic data
    
    Parameters:
    
    mab - bibliographic data
  - getComment
```
public java.lang.String getComment()
```
    retrieves the comment of the analysis
    
    Returns:
    
    comment comment
  - setProposedDeletion
```
public void setProposedDeletion(int newProposedDeletion)
```
    set the number of items proposed to be deleted
    
    Parameters:
    
    newProposedDeletion - number of items proposed to be deleted
  - getMeanRelativeLoan
```
public double getMeanRelativeLoan()
```
    retrieves the mean relative loan of items in stock throughout the analysis
    
    Returns:
    
    meanRelativeLoan mean relative loan
  - getMeanStock
```
public double getMeanStock()
```
    retrieves the mean number of items in stock throughout the analysis
    
    Returns:
    
    meanStock mean number of items in stock
  - getDescription
```
public java.lang.String getDescription()
```
    retrieves the description of the analysis
    
    Returns:
    
    description description
  - setDescription
```
public void setDescription(java.lang.String description)
```
    set the description of the analysis
    
    Parameters:
    
    description - description
  - getMaxRelativeLoan
```
public double getMaxRelativeLoan()
```
    retrieves the maximum relative loan throughout the period of analysis
    
    Returns:
    
    maxRelativeLoan maximum relative loan
  - setMaxRelativeLoan
```
public void setMaxRelativeLoan(double maxRelativeLoan)
```
    set the maximum relative loan throughout the period of analysis
    
    Parameters:
    
    maxRelativeLoan - maximum relative loan
  - getSlope
```
public double getSlope()
```
    retrieves the slope of the relative loan throughout the analysis
    
    Returns:
    
    slope slope of the relative loan
  - setSlope
```
public void setSlope(double slope)
```
    set the slope of the relative loan throughout the analysis
    
    Parameters:
    
    slope - slope of the relative loan
  - getLastStock
```
public int getLastStock()
```
    retrieves the number of items at the end of the analysis period
    
    Returns:
    
    lastStock number of items at the end of the analysis period
  - setLastStock
```
public void setLastStock(int lastStock)
```
    set the number of items at the end of the analysis period
    
    Parameters:
    
    lastStock - number of items at the end of the analysis period
  - getMaxLoansAbs
```
public int getMaxLoansAbs()
```
    retrieves the maximum number of items loaned throughout the period of analysis
    
    Returns:
    
    maxLoansAbs maximum number of items loaned
  - setMaxLoansAbs
```
public void setMaxLoansAbs(int maxLoansAbs)
```
    set the maximum number of items loaned throughout the period of analysis
    
    Parameters:
    
    maxLoansAbs - maximum number of items loaned
  - getMaxNumberRequest
```
public int getMaxNumberRequest()
```
    retrieves the maximum number of items requested throughout the period of analysis
    
    Returns:
    
    maxNumberRequest maximum number of items requested
  - increaseNumberRequests
```
public void increaseNumberRequests()
```
    increases the number of requests
  - setMaxNumberRequest
```
public void setMaxNumberRequest(int maxNumberRequest)
```
    set the maximum number of items requested throughout the period of analysis
    
    Parameters:
    
    maxNumberRequest - maximum number of items requested
  - getMaxItemsNeeded
```
public int getMaxItemsNeeded()
```
    retrieves the maximum number of items needed (stock and requests) throughout the period of analysis
    
    Returns:
    
    maxItemsNeeded maximum number of items needed (stock and requests)
  - setMaxItemsNeeded
```
public void setMaxItemsNeeded(int maxItemsNeeded)
```
    set the maximum number of items needed (stock and requests) throughout the period of analysis
    
    Parameters:
    
    maxItemsNeeded - maximum number of items needed (stock and requests)
  - getDaysRequested
```
public int getDaysRequested()
```
    retrieves the days items were requested throughout the period of analysis
    
    Returns:
    
    daysRequested days items were requested
  - setDaysRequested
```
public void setDaysRequested(int daysRequested)
```
    set the days items were requested throughout the period of analysis
    
    Parameters:
    
    daysRequested - days items were requested
  - getNumberRequests
```
public int getNumberRequests()
```
    retrieves the number of requests throughout the period of analysis
    
    Returns:
    
    numberRequests number of requests
  - setNumberRequests
```
public void setNumberRequests(int numberRequests)
```
    set the number of requests throughout the period of analysis
    
    Parameters:
    
    numberRequests - number of requests
  - getProposedPurchase
```
public int getProposedPurchase()
```
    retrieves the number of proposed purchases
    
    Returns:
    
    proposedPurchase number of proposed purchases
  - setProposedPurchase
```
public void setProposedPurchase(int proposedPurchase)
```
    set the number of proposed purchases
    
    Parameters:
    
    proposedPurchase - number of proposed purchases
  - getProposedDeletion
```
public int getProposedDeletion()
```
    retrieves the number of proposed deletions
    
    Returns:
    
    proposedDeletion number of proposed deletions
  - setMeanRelativeLoan
```
public void setMeanRelativeLoan(double meanRelativeLoan)
```
    set the mean relative loan throughout the period of analysis
    
    Parameters:
    
    meanRelativeLoan - the mean relative loan
  - setMeanStock
```
public void setMeanStock(double meanStock)
```
    set the mean stock throughout the period of analysis
    
    Parameters:
    
    meanStock - the mean stock
  - setComment
```
public void setComment(java.lang.String comment)
```
    set the comment of the analysis
    
    Parameters:
    
    comment - the comment
  - addAnalysisToOutput
```
public void addAnalysisToOutput(org.jdom2.Element parent)
```
    adds the analysis org.jdom2.element to the desired parent element
    
    Parameters:
    
    parent - the parent org.jdom2.element the analysis shall be added to
  - getShelfmarkBase
```
public java.lang.String getShelfmarkBase()
```
    retrieve the basic shelfmark without the edition information
    
    Returns:
    
    the shelfmarkBase
  - setShelfmarkBase
```
public void setShelfmarkBase(java.lang.String shelfmarkBase)
```
    set the basic shelfmark without the edition information
    
    Parameters:
    
    shelfmarkBase - the shelfmarkBase to set

Class EventAnalysis

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventAnalysis

Method Detail

getAuthor

setAuthor

getStockcontrol

setStockcontrol

getShelfmark

setShelfmark

getSystemCode

setSystemCode

getCollection

setCollection

getMaterials

setMaterials

getTimestamp

setTimestamp

getMab

setMab

getComment

setProposedDeletion

getMeanRelativeLoan

getMeanStock

getDescription

setDescription

getMaxRelativeLoan

setMaxRelativeLoan

getSlope

setSlope

getLastStock

setLastStock

getMaxLoansAbs

setMaxLoansAbs

getMaxNumberRequest

increaseNumberRequests

setMaxNumberRequest

getMaxItemsNeeded

setMaxItemsNeeded

getDaysRequested

setDaysRequested

getNumberRequests

setNumberRequests

getProposedPurchase

setProposedPurchase

getProposedDeletion

setMeanRelativeLoan

setMeanStock

setComment

addAnalysisToOutput

getShelfmarkBase

setShelfmarkBase