URLQueryModel (Blazegraph Database Platform 2.1.5 API)

java.lang.Object
- com.bigdata.counters.query.URLQueryModel

```
public class URLQueryModel
extends Object
```
The model for a URL used to query an ICounterSelector.

Version:

$Id$

Author:

Bryan Thompson

Field Summary

Fields
Modifier and Type	Field and Description
`String[]`	`category` The ordered labels to be assigned to the category columns in a `ReportEnum.pivot` report (optional).
`static String`	`CATEGORY` The ordered labels to be assigned to the category columns in a `ReportEnum.pivot` report.
`static String`	`CORRELATED` Name of the URL query parameter specifying whether the optional correlated view for counter histories will be displayed.
`Format`	`dateFormat` Used to format the timestamp fields (From:, To:, and the last column) and the epoch for `flot`.
`DecimalFormat`	`decimalFormat` Used to format double and float counter values.
`static String`	`DEFAULT_DEPTH`
`int`	`depth` The value of the `DEPTH` query parameter.
`static String`	`DEPTH` Depth to be displayed from the given path -or- ZERO (0) to display all levels.
`HashMap<Field,Pattern>`	`eventFilters` A collection of event filters.
`Field[]`	`eventOrderBy` The order in which the events will be grouped.
`IEventReportingService`	`eventReportingService` The events iff they are available from the service.
`File`	`file` The name of a local file on which to write the data (this option is supported only by local utility classes, not by the httpd interface).
`static String`	`FILE` Parameter recognized as the name of the local file on which to render the counters (this option is supported only by utility classes run from a command line, not by the httpd interface).
`static String`	`FILTER` Name of the URL query parameter specifying one or more strings for the filter to be applied to the counter paths.
`boolean`	`flot` `true` iff we need to output the scripts to support `flot`.
`long`	`fromTime` The inclusive lower bound in milliseconds of the timestamp for the counters or events to be selected.
`NumberFormat`	`integerFormat` Used to format integer and long counter values.
`String`	`mimeType` Optional override of the MIME type from a URL query parameter.
`static String`	`MIMETYPE` Optional override of the MIME type from a URL query parameter.
`LinkedHashMap<String,Vector<String>>`	`params` The parameters from the request (as parsed from URL query parameters).
`String`	`path` The value of the `PATH` query parameter.
`static String`	`PATH` Name of the URL query parameter specifying the starting path for the page view.
`Pattern`	`pattern` The `Pattern` compiled from the `FILTER` query parameters and `null` iff there are no `FILTER` query parameters.
`NumberFormat`	`percentFormat` Used to format counter values that can be inferred to be a percentage.
`PeriodEnum`	`period` The reporting period to be used.
`static String`	`PERIOD` The reporting period to be displayed.
`static String`	`REGEX` Name of the URL query parameter specifying one or more regular expression for the filter to be applied to the counter paths.
`static String`	`REPORT` URL query parameter whose value is the type of report to generate.
`ReportEnum`	`reportType` The kind of report to generate.
`static String`	`TIMESTAMP_FORMAT` Name of the URL query parameter specifying that the format for the first column of the history counter table view.
`TimestampFormatEnum`	`timestampFormat`
`long`	`toTime` The exclusive upper bound in milliseconds of the timestamp for the counters or events to be selected.
`DecimalFormat`	`unitsFormat` Used to format the units of time when expressed as elapsed units since the first sample of a `History`.
`String`	`uri` The URI from the request.

Method Summary

Methods
Modifier and Type	Method and Description
`protected static String`	`encodeURL(String url)`
`static URLQueryModel`	`getInstance(IService service, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)` Factory for Servlet API integration.
`static URLQueryModel`	`getInstance(IService service, String uri, LinkedHashMap<String,Vector<String>> params, Map<String,String> headers)` Factory for performance counter integration.
`static URLQueryModel`	`getInstance(URL url)` Create a `URLQueryModel` from a URL.
`protected static String`	`getProperty(Map<String,Vector<String>> params, String property, String defaultValue)` Return the first value for the named property.
`StringBuilder`	`getRequestURL()` Re-create the request URL, including the protocol, host, port, and path but not any query parameters.
`String`	`getRequestURL(URLQueryParam[] override)` Re-create the request URL.
`String`	`toString()`

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

- Field Detail
  - PATH
```
public static final String PATH
```
    Name of the URL query parameter specifying the starting path for the page view.
    
    See Also:
    Constant Field Values
  - DEPTH
```
public static final String DEPTH
```
    Depth to be displayed from the given path -or- ZERO (0) to display all levels.
    
    See Also:
    Constant Field Values
  - DEFAULT_DEPTH
```
public static final String DEFAULT_DEPTH
```
    See Also:
    BLZG-1318, Constant Field Values
  - REPORT
```
public static final String REPORT
```
    URL query parameter whose value is the type of report to generate. The default is ReportEnum.hierarchy.
    
    See Also:
    ReportEnum, Constant Field Values
  - CATEGORY
```
public static final String CATEGORY
```
    The ordered labels to be assigned to the category columns in a ReportEnum.pivot report. The order of the names in the URL query parameters MUST correspond with the order of the capturing groups in the REGEX.
    
    See Also:
    Constant Field Values
  - CORRELATED
```
public static final String CORRELATED
```
    Name of the URL query parameter specifying whether the optional correlated view for counter histories will be displayed.
    Note: This is a shorthand for specifying REPORT as .
    
    See Also:
    Constant Field Values
  - FILTER
```
public static final String FILTER
```
    Name of the URL query parameter specifying one or more strings for the filter to be applied to the counter paths.
    
    See Also:
    Constant Field Values
  - REGEX
```
public static final String REGEX
```
    Name of the URL query parameter specifying one or more regular expression for the filter to be applied to the counter paths. Any capturing groups in this regular expression will be used to generate the column title when examining correlated counters in a table view. If there are no capturing groups then the counter name is used as the default title.
    
    See Also:
    Constant Field Values
  - TIMESTAMP_FORMAT
```
public static final String TIMESTAMP_FORMAT
```
    Name of the URL query parameter specifying that the format for the first column of the history counter table view. This column is the timestamp associated with the counter but it can be reported in a variety of ways. The possible values for this option are specified by TimestampFormatEnum.
    
    See Also:
    TimestampFormatEnum, Constant Field Values
  - PERIOD
```
public static final String PERIOD
```
    The reporting period to be displayed. When not specified, all periods will be reported. The value may be any PeriodEnum.
    
    See Also:
    Constant Field Values
  - MIMETYPE
```
public static final String MIMETYPE
```
    Optional override of the MIME type from a URL query parameter.
    
    See Also:
    Constant Field Values
  - FILE
```
public static final String FILE
```
    Parameter recognized as the name of the local file on which to render the counters (this option is supported only by utility classes run from a command line, not by the httpd interface).
    
    See Also:
    Constant Field Values
  - eventFilters
```
public final HashMap<Field,Pattern> eventFilters
```
    A collection of event filters. Each filter is a regular expression. The key is the Event Field to which the filter will be applied. The events filters are specified using URL query parameters having the general form: events.column=regex. For example,
```
 events.majorEventType = AsynchronousOverflow
 
```
    would select just the asynchronous overflow events and
```
 events.hostname=blade12.*
 
```
    would select events reported for blade12.
  - eventOrderBy
```
public final Field[] eventOrderBy
```
    The order in which the events will be grouped.
    
    See Also:
    EVENT_ORDER_BY
  - uri
```
public final String uri
```
    The URI from the request.
  - params
```
public final LinkedHashMap<String,Vector<String>> params
```
    The parameters from the request (as parsed from URL query parameters).
  - path
```
public final String path
```
    The value of the PATH query parameter.
  - depth
```
public final int depth
```
    The value of the DEPTH query parameter.
  - reportType
```
public final ReportEnum reportType
```
    The kind of report to generate.
    
    See Also:
    REPORT, ReportEnum
  - timestampFormat
```
public final TimestampFormatEnum timestampFormat
```
    See Also:
    TIMESTAMP_FORMAT, TimestampFormatEnum
  - category
```
public final String[] category
```
    The ordered labels to be assigned to the category columns in a ReportEnum.pivot report (optional). The order of the names in the URL query parameters MUST correspond with the order of the capturing groups in the REGEX.
    
    See Also:
    CATEGORY
  - fromTime
```
public final long fromTime
```
    The inclusive lower bound in milliseconds of the timestamp for the counters or events to be selected.
  - toTime
```
public final long toTime
```
    The exclusive upper bound in milliseconds of the timestamp for the counters or events to be selected.
  - period
```
public final PeriodEnum period
```
    The reporting period to be used. When null all periods will be reported. When specified, only that period is reported.
  - pattern
```
public final Pattern pattern
```
    The Pattern compiled from the FILTER query parameters and null iff there are no FILTER query parameters.
  - eventReportingService
```
public final IEventReportingService eventReportingService
```
    The events iff they are available from the service.
    
    See Also:
    IEventReportingService
  - flot
```
public final boolean flot
```
    true iff we need to output the scripts to support flot.
  - decimalFormat
```
public final DecimalFormat decimalFormat
```
    Used to format double and float counter values.
  - percentFormat
```
public final NumberFormat percentFormat
```
    Used to format counter values that can be inferred to be a percentage.
  - integerFormat
```
public final NumberFormat integerFormat
```
    Used to format integer and long counter values.
  - unitsFormat
```
public final DecimalFormat unitsFormat
```
    Used to format the units of time when expressed as elapsed units since the first sample of a History.
  - dateFormat
```
public final Format dateFormat
```
    Used to format the timestamp fields (From:, To:, and the last column) and the epoch for flot. This is set dynamically based on the TIMESTAMP_FORMAT and the PERIOD. Flot always requires epoch numbering, so it does not use this field.
  - mimeType
```
public final String mimeType
```
    Optional override of the MIME type from a URL query parameter.
    
    See Also:
    MIMETYPE
  - file
```
public final File file
```
    The name of a local file on which to write the data (this option is supported only by local utility classes, not by the httpd interface).
    
    See Also:
    FILE
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getInstance
```
public static URLQueryModel getInstance(IService service,
                        String uri,
                        LinkedHashMap<String,Vector<String>> params,
                        Map<String,String> headers)
```
    Factory for performance counter integration.
    
    Parameters:
    service - The service object IFF one was specified when CounterSetHTTPD was started.
    uri - Percent-decoded URI without parameters, for example "/index.cgi"
    parms - Parsed, percent decoded parameters from URI and, in case of POST, data. The keys are the parameter names. Each value is a Vector of Strings containing the bindings for the named parameter. The order of the URL parameters is preserved by the insertion order of the LinkedHashMap and the elements of the Vector values.
    header - Header entries, percent decoded
  - getInstance
```
public static URLQueryModel getInstance(IService service,
                        javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse resp)
                                 throws UnsupportedEncodingException
```
    Factory for Servlet API integration.
    
    Parameters:
    service - The service object IFF one was specified when CounterSetHTTPD was started. If this implements the IEventReportingService interface, then events can also be requested.
    req - The request.
    resp - The response.
    
    Throws:
    
    UnsupportedEncodingException
  - getInstance
```
public static URLQueryModel getInstance(URL url)
                                 throws UnsupportedEncodingException
```
    Create a URLQueryModel from a URL. This is useful when serving historical performance counter data out of a file.
    
    Parameters:
    url - The URL.
    
    Returns:
    The URLQueryModel
    
    Throws:
    
    UnsupportedEncodingException
  - getProperty
```
protected static String getProperty(Map<String,Vector<String>> params,
                 String property,
                 String defaultValue)
```
    Return the first value for the named property.
    
    Parameters:
    params - The request parameters.
    property - The name of the property
    defaultValue - The default value (optional).
    
    Returns:
    The first value for the named property and the defaultValue if there named property was not present in the request.
  - getRequestURL
```
public StringBuilder getRequestURL()
```
    Re-create the request URL, including the protocol, host, port, and path but not any query parameters.
  - getRequestURL
```
public String getRequestURL(URLQueryParam[] override)
```
    Re-create the request URL.
    
    Parameters:
    override - Overridden query parameters (optional).
  - encodeURL
```
protected static String encodeURL(String url)
```

Class URLQueryModel

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATH

DEPTH

DEFAULT_DEPTH

REPORT

CATEGORY

CORRELATED

FILTER

REGEX

TIMESTAMP_FORMAT

PERIOD

MIMETYPE

FILE

eventFilters

eventOrderBy

uri

params

path

depth

reportType

timestampFormat

category

fromTime

toTime

period

pattern

eventReportingService

flot

decimalFormat

percentFormat

integerFormat

unitsFormat

dateFormat

mimeType

file

Method Detail

toString

getInstance

getInstance

getInstance

getProperty

getRequestURL

getRequestURL

encodeURL