slightly more robust XML parsing of the GPX track (elevation is now
[utils] / crawler / basic / src / org / wamblee / crawler / Action.java
1 /*
2  * Copyright 2005 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */ 
16
17 package org.wamblee.crawler;
18
19 import org.dom4j.Element;
20
21 /**
22  * An action defined on a page. 
23  */
24 public interface Action {
25     
26     /**
27      * The name of the action. 
28      * @return Action name. 
29      */
30     String getName(); 
31     
32     /**
33      * Executes the action. 
34      * @return New page as a result of the action.
35      * @throws PageException In case of an error obtaining the page. 
36      */
37     Page execute() throws PageException;
38     
39     /**
40      * Gets a description of the action. THe element returned is the action element
41      * itself. 
42      * @return Content as XML.
43      */
44     Element getContent();
45 }