-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
CoverageRequest.java
101 lines (87 loc) · 3.5 KB
/
CoverageRequest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2008, Open Source Geospatial Foundation (OSGeo)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.geotools.coverage.io;
import java.util.Map;
import org.geotools.api.data.Parameter;
import org.geotools.api.feature.type.Name;
import org.geotools.util.factory.Hints;
/**
* @author Simone Giannecchini, GeoSolutions
* @author Jody Garnett
*/
public abstract class CoverageRequest {
/** @uml.property name="name" */
private Name name;
/** @uml.property name="handle" */
private String handle;
/** @uml.property name="hints" */
private Hints hints;
/** @uml.property name="additionalParameters" */
private Map<String, Parameter<?>> additionalParameters;
/**
* The handle attribute is included to allow a client to associate a mnemonic name to the Query
* request. The purpose of the handle attribute is to provide an error handling mechanism for
* locating a statement that might fail.
*
* @return the mnemonic name of the query request.
* @uml.property name="handle"
*/
public String getHandle() {
return handle;
}
/** @see org.geotools.coverage.io.CoverageRequest#setHandle(java.lang.String) */
public void setHandle(String handle) {
this.handle = handle;
}
/**
* Specifies some hints to drive the query execution and results build-up.
*
* <p>Hints examples can be the GeometryFactory to be used, a generalization distance to be
* applied right in the data store, to data store specific things such as the fetch size to be
* used in JDBC queries. The set of hints supported can be fetched by calling {@links
* FeatureSource#getSupportedHints()} . Depending on the actual values of the hints, the data
* store is free to ignore them. No mechanism is in place, at the moment, to figure out which
* hints where actually used during the query execution.
*
* @return the Hints the data store should try to use when executing the query (eventually empty
* but never null).
* @uml.property name="hints"
*/
public Hints getHints() {
return hints;
}
/** @see org.geotools.coverage.io.CoverageRequest#setHints(Hints) */
public void setHints(Hints hints) {
this.hints = hints;
}
/** @see org.geotools.coverage.io.CoverageRequest#setAdditionalParameters(Map) */
public void setAdditionalParameters(Map<String, Parameter<?>> additionalParameters) {
this.additionalParameters = additionalParameters;
}
/** @see org.geotools.coverage.io.CoverageRequest#getAdditionalParameters() */
public Map<String, Parameter<?>> getAdditionalParameters() {
return additionalParameters;
}
/** @see org.geotools.coverage.io.CoverageRequest#getName() */
public Name getName() {
return name;
}
/** @see org.geotools.coverage.io.CoverageRequest#setName(org.geotools.api.feature.type.Name) */
public void setName(Name name) {
this.name = name;
}
}