##### Coverage Report - org.apache.any23.extractor.xpath.TemplateXPathExtractionRule

Classes in this File | Line Coverage | Branch Coverage | Complexity
TemplateXPathExtractionRule |
N/A | N/A
N/A | N/A
| 1.0;1

1 |  |
     /*
2 |  |
      * Licensed to the Apache Software Foundation (ASF) under one or more
3 |  |
      * contributor license agreements.  See the NOTICE file distributed with
4 |  |
      * this work for additional information regarding copyright ownership.
5 |  |
      * The ASF licenses this file to You under the Apache License, Version 2.0
6 |  |
      * (the "License"); you may not use this file except in compliance with
7 |  |
      * the License.  You may obtain a copy of the License at
8 |  |
      *
9 |  |
      *  http://www.apache.org/licenses/LICENSE-2.0
10 |  |
      *
11 |  |
      * Unless required by applicable law or agreed to in writing, software
12 |  |
      * distributed under the License is distributed on an "AS IS" BASIS,
13 |  |
      * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 |  |
      * See the License for the specific language governing permissions and
15 |  |
      * limitations under the License.
16 |  |
      */
17 |  |
18 |  |
     package org.apache.any23.extractor.xpath;
19 |  |
20 |  |
     /**
21 |  |
      * Defines an {@link XPathExtractionRule} able
22 |  |
      * to expand a {@link QuadTemplate} set based
23 |  |
      * on a given template.
24 |  |
      *
25 |  |
      * @author Michele Mostarda (mostarda@fbk.eu)
26 |  |
      */
27 |  |
     public interface TemplateXPathExtractionRule extends XPathExtractionRule {
28 |  |
29 |  |
         /**
30 |  |
          * @return human readable description for this rule.
31 |  |
          */
32 |  |
         public String getName();
33 |  |
34 |  |
         /**
35 |  |
          * Adds a variable to the template.
36 |  |
          *
37 |  |
          * @param variable variable to be added.
38 |  |
          */
39 |  |
         public void add(Variable variable);
40 |  |
41 |  |
         /**
42 |  |
          * Removes a variable from the template.
43 |  |
          *
44 |  |
          * @param variable variable to be removed.
45 |  |
          * @return <code>true</i> if the <code>variable</code> argument was found.
46 |  |
          */
47 |  |
         public boolean remove(Variable variable);
48 |  |
49 |  |
         /**
50 |  |
          * Adds a {@link QuadTemplate} to the rule.
51 |  |
          *
52 |  |
          * @param template template instance to be added.
53 |  |
          */
54 |  |
         public void add(QuadTemplate template);
55 |  |
56 |  |
         /**
57 |  |
          * Removes a quad template from the rule.
58 |  |
          *
59 |  |
          * @param template template to be removed.
60 |  |
          * @return <code>true</code> if the <code>template</code>
61 |  |
          *         argument was found.
62 |  |
          */
63 |  |
         public boolean remove(QuadTemplate template);
64 |  |
65 |  |
     }