| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| DeclarativeConstraint |
|
| 1.0;1 |
| 1 | package org.apache.maven.archiva.database; | |
| 2 | ||
| 3 | /* | |
| 4 | * Licensed to the Apache Software Foundation (ASF) under one | |
| 5 | * or more contributor license agreements. See the NOTICE file | |
| 6 | * distributed with this work for additional information | |
| 7 | * regarding copyright ownership. The ASF licenses this file | |
| 8 | * to you under the Apache License, Version 2.0 (the | |
| 9 | * "License"); you may not use this file except in compliance | |
| 10 | * with the License. You may obtain a copy of the License at | |
| 11 | * | |
| 12 | * http://www.apache.org/licenses/LICENSE-2.0 | |
| 13 | * | |
| 14 | * Unless required by applicable law or agreed to in writing, | |
| 15 | * software distributed under the License is distributed on an | |
| 16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| 17 | * KIND, either express or implied. See the License for the | |
| 18 | * specific language governing permissions and limitations | |
| 19 | * under the License. | |
| 20 | */ | |
| 21 | ||
| 22 | /** | |
| 23 | * DeclarativeConstraint | |
| 24 | * | |
| 25 | * @version $Id: DeclarativeConstraint.java 718864 2008-11-19 06:33:35Z brett $ | |
| 26 | */ | |
| 27 | public interface DeclarativeConstraint | |
| 28 | extends Constraint | |
| 29 | { | |
| 30 | /** | |
| 31 | * Get the declared imports used for this query. (optional) | |
| 32 | * <p/> | |
| 33 | * NOTE: This is DAO implementation specific. | |
| 34 | * | |
| 35 | * @return the imports. (can be null) | |
| 36 | */ | |
| 37 | public abstract String[] getDeclaredImports(); | |
| 38 | ||
| 39 | /** | |
| 40 | * Get the declared parameters used for this query. (optional) | |
| 41 | * <p/> | |
| 42 | * NOTE: This is DAO implementation specific. | |
| 43 | * | |
| 44 | * @return the parameters. (can be null) | |
| 45 | */ | |
| 46 | public abstract String[] getDeclaredParameters(); | |
| 47 | ||
| 48 | /** | |
| 49 | * The JDOQL filter to apply to the query. (optional) | |
| 50 | * <p/> | |
| 51 | * NOTE: This is DAO implementation specific. | |
| 52 | * | |
| 53 | * @return the filter to apply. (can be null) | |
| 54 | */ | |
| 55 | public abstract String getFilter(); | |
| 56 | ||
| 57 | /** | |
| 58 | * Get the parameters used for this query. (required if using {@link #getDeclaredParameters()} ) | |
| 59 | * <p/> | |
| 60 | * NOTE: This is DAO implementation specific. | |
| 61 | * | |
| 62 | * @return the parameters. (can be null) | |
| 63 | */ | |
| 64 | public abstract Object[] getParameters(); | |
| 65 | ||
| 66 | /** | |
| 67 | * Get the sort direction name. | |
| 68 | * | |
| 69 | * @return the sort direction name. ("ASC" or "DESC") (only valid if {@link #getSortColumn()} is specified.) | |
| 70 | */ | |
| 71 | public abstract String getSortDirection(); | |
| 72 | ||
| 73 | /** | |
| 74 | * Get the sort column name. | |
| 75 | * | |
| 76 | * @return the sort column name. (can be null) | |
| 77 | */ | |
| 78 | public abstract String getSortColumn(); | |
| 79 | ||
| 80 | /** | |
| 81 | * Get the variables used within the query. | |
| 82 | * <p/> | |
| 83 | * NOTE: This is DAO implementation specific. | |
| 84 | * | |
| 85 | * @return the variables used within the query. | |
| 86 | */ | |
| 87 | public abstract String[] getVariables(); | |
| 88 | ||
| 89 | /** | |
| 90 | * Get the SELECT WHERE (condition) value for the constraint. | |
| 91 | * | |
| 92 | * @return the equivalent of the SELECT WHERE (condition) value for this constraint. (can be null) | |
| 93 | */ | |
| 94 | public abstract String getWhereCondition(); | |
| 95 | ||
| 96 | /** | |
| 97 | * Get the declared range used for this query. (optional) | |
| 98 | * <p/> | |
| 99 | * NOTE: This is DAO implementation specific. | |
| 100 | * | |
| 101 | * @return the range. (can be null) | |
| 102 | */ | |
| 103 | public abstract int[] getRange(); | |
| 104 | } |