Limits (CAFrontEnd API Specification)

java.lang.Object
- core.tut.pori.http.parameters.HTTPParameter
- - core.tut.pori.http.parameters.Limits

```
public final class Limits
extends HTTPParameter
```
The default parser for limit parameters, the syntax being: ?limits=START_ITEM-END_ITEM with a possible open ended limit for END_ITEM, e.g. ?limits=START_ITEM in this case the END_ITEM is automatically assigned to START_ITEM+DEFAULT_MAX_ITEMS-1 It is also possible to provide limits for a specific type with ?limits=TYPE;START_ITEM-END_ITEM or for types with ?limits=TYPE;START_ITEM-END_ITEM,TYPE;START_ITEM-END_ITEM, the type limits can be retrieved using the parameterized getters, if no limits were provided for the type, default limits will be returned It is also possible to provide both the default limit and type specific limits: ?limits=START_ITEM-END_ITEM,TYPE;START_ITEM-END_ITEM Providing only the - character as a limit should as ?limits=- will be assumed to mean max items = 0, i.e. return nothing, this can also be used with typed limits, e.g. ?limits=0-1,TYPE;- to return no result for a specific type. The limits have no specific processing order, and can also be given in any order in the limits clause. The given order is generally internally preserved, though conceptually, no such order exists.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Limits.TypeLimits
A type specific limit clause.

Nested Classes
Modifier and Type	Class and Description
`class`	`Limits.TypeLimits` A type specific limit clause.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_ITEMS` The default maximum amount of items if no last item is specified
`static java.lang.String`	`PARAMETER_DEFAULT_NAME` the default HTTP parameter name

Constructor Summary

Constructors
Constructor and Description

Limits()
create default limits

Limits(int startItem, int endItem)
Initialize limits

Constructors
Constructor and Description
`Limits()` create default limits
`Limits(int startItem, int endItem)` Initialize limits

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getEndItem()`
`int`	`getEndItem(java.lang.String typeName)`
`int`	`getMaxItems()`
`int`	`getMaxItems(java.lang.String typeName)`
`int`	`getStartItem()`
`int`	`getStartItem(java.lang.String typeName)`
`Limits.TypeLimits`	`getTypeLimits(java.lang.String typeName)` Note: if no limits for the given typeName is found, this will return the default limits.
`java.lang.Object`	`getValue()`
`boolean`	`hasValues()` always true
`void`	`initialize(java.util.List<java.lang.String> parameterValues)` Initialize this parameter based on the given parameter values
`void`	`initialize(java.lang.String parameterValue)` Initialize this parameter based on the given parameter value
`void`	`setTypeLimits(int startItem, int endItem, java.lang.String typeName)`
`java.lang.String`	`toLimitString()`

Methods inherited from class core.tut.pori.http.parameters.HTTPParameter
getParameterName, initialize, initializeRaw, initializeRaw, setParameterName

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

- Field Detail
  - PARAMETER_DEFAULT_NAME
```
public static final java.lang.String PARAMETER_DEFAULT_NAME
```
    the default HTTP parameter name
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_ITEMS
```
public static final int DEFAULT_MAX_ITEMS
```
    The default maximum amount of items if no last item is specified
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Limits
```
public Limits(int startItem,
              int endItem)
```
    Initialize limits
    
    Parameters:
    
    startItem - if < 0, 0 will be used
    
    endItem - the last item index (inclusively), if <= startItem, startItem+DEFAULT_MAX_ITEM-1 will be used
  - Limits
```
public Limits()
```
    create default limits
- Method Detail
  - toLimitString
```
public java.lang.String toLimitString()
```
    Returns:
    
    the limits as a limits string (query parameter value, without the parameter name and equals sign), or null if no limits
  - setTypeLimits
```
public void setTypeLimits(int startItem,
                          int endItem,
                          java.lang.String typeName)
```
    Parameters:
    
    startItem -
    
    endItem -
    
    typeName - setting to null will replace the default (global) limits
  - getStartItem
```
public int getStartItem()
```
    Returns:
    
    start item index
  - getEndItem
```
public int getEndItem()
```
    Returns:
    
    the endItem index
  - getMaxItems
```
public int getMaxItems()
```
    Returns:
    
    maximum number of items
  - getStartItem
```
public int getStartItem(java.lang.String typeName)
```
    Parameters:
    
    typeName -
    
    Returns:
    
    start item index for the given type or if the type does not exist, the general start item
  - getEndItem
```
public int getEndItem(java.lang.String typeName)
```
    Parameters:
    
    typeName -
    
    Returns:
    
    the end item index or if the type is not defined, the general end item
  - getTypeLimits
```
public Limits.TypeLimits getTypeLimits(java.lang.String typeName)
```
    Note: if no limits for the given typeName is found, this will return the default limits. Whether default limits were returned or not can be checked by callint TypeLimits.getTypeName(), which will return null on default limits.
    
    Parameters:
    
    typeName -
    
    Returns:
    
    type limits for the requested type
  - getMaxItems
```
public int getMaxItems(java.lang.String typeName)
```
    Parameters:
    
    typeName -
    
    Returns:
    
    maximum number of items for the given type or maximum number of items in general if the given type is not defined
  - initialize
```
public void initialize(java.util.List<java.lang.String> parameterValues)
                throws java.lang.IllegalArgumentException
```
    Description copied from class: HTTPParameter
    
    Initialize this parameter based on the given parameter values
    
    Specified by:
    
    initialize in class HTTPParameter
    
    Parameters:
    
    parameterValues - can NOT be null
    
    Throws:
    
    java.lang.IllegalArgumentException - on bad input data
  - initialize
```
public void initialize(java.lang.String parameterValue)
                throws java.lang.IllegalArgumentException
```
    Description copied from class: HTTPParameter
    
    Initialize this parameter based on the given parameter value
    
    Specified by:
    
    initialize in class HTTPParameter
    
    Parameters:
    
    parameterValue - can be null
    
    Throws:
    
    java.lang.IllegalArgumentException - on bad input data
  - hasValues
```
public boolean hasValues()
```
    always true
    
    Specified by:
    
    hasValues in class HTTPParameter
    
    Returns:
    
    true if this parameter has one or more values
  - getValue
```
public java.lang.Object getValue()
```
    Specified by:
    
    getValue in class HTTPParameter
    
    Returns:
    
    there is no single value available, this always returns null

Class Limits

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class core.tut.pori.http.parameters.HTTPParameter

Methods inherited from class java.lang.Object

Field Detail

PARAMETER_DEFAULT_NAME

DEFAULT_MAX_ITEMS

Constructor Detail

Limits

Limits

Method Detail

toLimitString

setTypeLimits

getStartItem

getEndItem

getMaxItems

getStartItem

getEndItem

getTypeLimits

getMaxItems

initialize

initialize

hasValues

getValue