Package org.dspace.app.rest.model

Class UsageReportPointRest

java.lang.Object

org.dspace.app.rest.model.RestAddressableModel

org.dspace.app.rest.model.BaseObjectRest<String>

org.dspace.app.rest.model.UsageReportPointRest

All Implemented Interfaces:

Serializable, RestModel

Direct Known Subclasses:

UsageReportPointCityRest, UsageReportPointCountryRest, UsageReportPointDateRest, UsageReportPointDsoTotalVisitsRest

public class UsageReportPointRest
extends BaseObjectRest<String>

This class serves as a REST representation of a Point of a UsageReportRest from the DSpace statistics

Author:

Maria Verdonck (Atmire) on 08/06/2020

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	CATEGORY
protected String	id
protected String	label
static String	NAME

Fields inherited from interface org.dspace.app.rest.model.RestModel

AUTHENTICATION, AUTHORIZATION, CONFIGURATION, CORE, DISCOVER, EPERSON, INTEGRATION, ROOT, STATISTICS, SUBMISSION, SYSTEM, VERSIONING, WORKFLOW

Constructor Summary

Constructors

Constructor	Description
UsageReportPointRest()

Method Summary

Modifier and Type	Method	Description
void	addValue(String key, Integer value)	Add a value pair to this UsageReportPointRest object's values
String	getCategory()	Returns the category of this Rest object, CATEGORY
Class	getController()	Return controller class responsible for this Rest object
String	getId()	Returns the id of this UsageReportPointRest object, of the form: type of UsageReport_dso uuid
String	getLabel()	Returns label of this UsageReportPointRest object, e.g.
String	getType()	Returns the type of this UsageReportPointRest object
Map<String,Integer>	getValues()	Returns the values of this UsageReportPointRest object, containing the amount of views
void	setId(String id)	Set the id of this UsageReportPointRest object, of the form: type of UsageReport_dso uuid
void	setLabel(String label)	Sets the label of this UsageReportPointRest object, e.g.
void	setValues(Map<String,Integer> values)	Sets all values of this UsageReportPointRest object

Methods inherited from class org.dspace.app.rest.model.BaseObjectRest

getErrors, setErrors

Methods inherited from class org.dspace.app.rest.model.RestAddressableModel

getEmbedLevel, getProjection, getUniqueType, setEmbedLevel, setProjection

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dspace.app.rest.model.RestModel

getTypePlural

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

CATEGORY

public static final String CATEGORY

See Also:

Constant Field Values

id

protected String id

label

protected String label

Constructor Detail

UsageReportPointRest

public UsageReportPointRest()

Method Detail

getCategory

public String getCategory()

Returns the category of this Rest object, CATEGORY

Specified by:

getCategory in class RestAddressableModel

Returns:

The category of this Rest object, CATEGORY

getController

public Class getController()

Return controller class responsible for this Rest object

Specified by:

getController in class RestAddressableModel

Returns:

Controller class responsible for this Rest object

getType

public String getType()

Returns the type of this UsageReportPointRest object

Returns:

Type of this UsageReportPointRest object

getValues

public Map<String,Integer> getValues()

Returns the values of this UsageReportPointRest object, containing the amount of views

Returns:

The values of this UsageReportPointRest object, containing the amount of views

getId

public String getId()

Returns the id of this UsageReportPointRest object, of the form: type of UsageReport_dso uuid

Overrides:

getId in class BaseObjectRest<String>

Returns:

The id of this UsageReportPointRest object, of the form: type of UsageReport_dso uuid

setId

public void setId(String id)

Set the id of this UsageReportPointRest object, of the form: type of UsageReport_dso uuid

Overrides:

setId in class BaseObjectRest<String>

Parameters:

id - The id of this UsageReportPointRest object, of the form: type of UsageReport_dso uuid

addValue

public void addValue(String key,
                     Integer value)

Add a value pair to this UsageReportPointRest object's values

Parameters:

key - Key of new value pair

value - Value of new value pair

setValues

public void setValues(Map<String,Integer> values)

Sets all values of this UsageReportPointRest object

Parameters:

values - All values of this UsageReportPointRest object

getLabel

public String getLabel()

Returns label of this UsageReportPointRest object, e.g. the dso's name

Returns:

Label of this UsageReportPointRest object, e.g. the dso's name

setLabel

public void setLabel(String label)

Sets the label of this UsageReportPointRest object, e.g. the dso's name

Parameters:

label - Label of this UsageReportPointRest object, e.g. the dso's name