unidue.ub.statistics.stockcontrol

Class StockControlProperties

java.lang.Object

unidue.ub.statistics.stockcontrol.StockControlProperties

public class StockControlProperties
extends java.lang.Object

Holds all the information for the analysis of stock regions.

Version:

1

Author:

Eike Spielberg

Constructor Summary

Constructors

Constructor and Description
StockControlProperties(java.lang.String stockControl, java.lang.String author) building stock control properties with default values

Method Summary

Modifier and Type	Method and Description
void	addStockControlToOutput(org.jdom2.Element parent) attaches an XML version of the stock control properties to the parent xml node
static StockControlProperties	buildSCPFromRequest(javax.servlet.http.HttpServletRequest req) reads the parameters from the http request to modify the corresponding fields of the default stock control properteis
java.lang.Double	getBlacklistExpire() returns the standard number of years on the blacklist before items are considered again
java.lang.String	getDeletionMailBcc() returns the BCC recipient of the deletion mail
java.lang.String	getSCCollections() returns the collections to be analyzed
java.lang.String	getSCMaterials() returns the materials to be analyzed
java.lang.Integer	getSCMinimumDaysOfRequest() returns the minimum number of days for a request to be analyzed
java.lang.Integer	getSCMinimumYears() returns the minimum number of years an item has to be in stock to be considered for deletion
java.lang.Double	getSCStaticBuffer() returns the static buffer used to calculate the proposed deletion
java.lang.String	getSCSubjectID() returns the subject (ID according to GHBSYS) to be analyzed
java.lang.String	getSCSystemCode() returns the notation to be analyzed
java.lang.Integer	getSCThreshold() returns the threshold for the proposed deletions
java.lang.Double	getSCVariableBuffer() returns the variable buffer used to calculate the proposed deletion
java.lang.Integer	getSCYearsOfRequests() returns the years in which requests are analyzed
java.lang.Integer	getSCYearsToAverage() returns the years used for the analysis
java.lang.String	getStockControl() returns the stock control key
boolean	isGroupedAnalysis() tests, whether to perform a grouped analysis
void	setBlacklistExpire(java.lang.Double blacklistExpire) sets the standard number of years on the blacklist before items are considered again
void	setGroupedAnalysis(boolean groupedAnalysis) sets boolean, whether to perform a grouped analysis
void	setSCCollections(java.lang.String collections) sets the collections to be analyzed
void	setSCMaterials(java.lang.String materials) sets the materials to be analyzed
void	setSCMinimumDaysOfRequest(int minimumDaysOfRequest) sets the minimum number of days for a request to be analyzed
void	setSCSubjectID(java.lang.String subjectID) sets the subject (ID according to GHBSYS) to be analyzed
void	setSCSystemCode(java.lang.String systemCode) sets the notation to be analyzed
void	setSCYearsOfRequests(int yearsOfRequests) sets the years in which requests are analyzed
void	setSCYearsToAverage(int yearsToAverage) sets the years used for the analysis
void	setStockControl(java.lang.String stockControl) sets the stock control key

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StockControlProperties

public StockControlProperties(java.lang.String stockControl,
                              java.lang.String author)
                       throws java.util.InvalidPropertiesFormatException,
                              java.io.IOException

building stock control properties with default values

Parameters:

stockControl - stock control key

author - logged in user

Throws:

java.util.InvalidPropertiesFormatException - exception while parsing properties file

java.io.IOException - exception while reading file from disk

Method Detail

getBlacklistExpire

public java.lang.Double getBlacklistExpire()

returns the standard number of years on the blacklist before items are considered again

Returns:

blacklistExpire the number of years on the blacklist

setBlacklistExpire

public void setBlacklistExpire(java.lang.Double blacklistExpire)

sets the standard number of years on the blacklist before items are considered again

Parameters:

blacklistExpire - the number of years on the blacklist

setSCYearsToAverage

public void setSCYearsToAverage(int yearsToAverage)

sets the years used for the analysis

Parameters:

yearsToAverage - the years for the analysis

setSCMinimumDaysOfRequest

public void setSCMinimumDaysOfRequest(int minimumDaysOfRequest)

sets the minimum number of days for a request to be analyzed

Parameters:

minimumDaysOfRequest - the minimum number of days for requests

setSCYearsOfRequests

public void setSCYearsOfRequests(int yearsOfRequests)

sets the years in which requests are analyzed

Parameters:

yearsOfRequests - the years for requests

setSCCollections

public void setSCCollections(java.lang.String collections)

sets the collections to be analyzed

Parameters:

collections - the collections (separated by blanks)

setSCMaterials

public void setSCMaterials(java.lang.String materials)

sets the materials to be analyzed

Parameters:

materials - materials (separated by blanks)

setSCSystemCode

public void setSCSystemCode(java.lang.String systemCode)

sets the notation to be analyzed

Parameters:

systemCode - the notation

setSCSubjectID

public void setSCSubjectID(java.lang.String subjectID)

sets the subject (ID according to GHBSYS) to be analyzed

Parameters:

subjectID - subject ID

setStockControl

public void setStockControl(java.lang.String stockControl)

sets the stock control key

Parameters:

stockControl - stock control key

getStockControl

public java.lang.String getStockControl()

returns the stock control key

Returns:

stockControl stock control key

getSCCollections

public java.lang.String getSCCollections()

returns the collections to be analyzed

Returns:

collections the collections (separated by blanks)

getSCMaterials

public java.lang.String getSCMaterials()

returns the materials to be analyzed

Returns:

materials the materials (separated by blanks)

getSCSubjectID

public java.lang.String getSCSubjectID()

returns the subject (ID according to GHBSYS) to be analyzed

Returns:

subjectID subject ID

getSCSystemCode

public java.lang.String getSCSystemCode()

returns the notation to be analyzed

Returns:

systemCode the notation

getDeletionMailBcc

public java.lang.String getDeletionMailBcc()

returns the BCC recipient of the deletion mail

Returns:

deletionMailBcc the BCC recipient

getSCStaticBuffer

public java.lang.Double getSCStaticBuffer()

returns the static buffer used to calculate the proposed deletion

Returns:

staticBuffer the staticBuffer

getSCVariableBuffer

public java.lang.Double getSCVariableBuffer()

returns the variable buffer used to calculate the proposed deletion

Returns:

variableBuffer the variable buffer

getSCYearsToAverage

public java.lang.Integer getSCYearsToAverage()

returns the years used for the analysis

Returns:

yearsToAverage the years used for the analysis

getSCThreshold

public java.lang.Integer getSCThreshold()

returns the threshold for the proposed deletions

Returns:

threshold the threshold

getSCMinimumYears

public java.lang.Integer getSCMinimumYears()

returns the minimum number of years an item has to be in stock to be considered for deletion

Returns:

minimumYears the minimum number of years

getSCYearsOfRequests

public java.lang.Integer getSCYearsOfRequests()

returns the years in which requests are analyzed

Returns:

yearsOfRequests years for requests

getSCMinimumDaysOfRequest

public java.lang.Integer getSCMinimumDaysOfRequest()

returns the minimum number of days for a request to be analyzed

Returns:

minimumDaysOfRequest the minimum number of days for a request

addStockControlToOutput

public void addStockControlToOutput(org.jdom2.Element parent)

attaches an XML version of the stock control properties to the parent xml node

Parameters:

parent - the parent xml node

buildSCPFromRequest

public static StockControlProperties buildSCPFromRequest(javax.servlet.http.HttpServletRequest req)
                                                  throws java.util.InvalidPropertiesFormatException,
                                                         java.io.IOException

reads the parameters from the http request to modify the corresponding fields of the default stock control properteis

Parameters:

req - the http-request

Returns:

scp stock control properties

Throws:

java.util.InvalidPropertiesFormatException - exception while parsing properties file

java.io.IOException - exception while reading file from disk

isGroupedAnalysis

public boolean isGroupedAnalysis()

tests, whether to perform a grouped analysis

Returns:

isGroupedAnalysis true, if grouped analysis is to be performed

setGroupedAnalysis

public void setGroupedAnalysis(boolean groupedAnalysis)

sets boolean, whether to perform a grouped analysis

Parameters:

groupedAnalysis - true, if grouped analysis is to be performed