(no commit message)
[utils] / crawler / basic / src / main / java / org / wamblee / crawler / Page.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  * Represents a retrieved page. 
23  *
24  * @author Erik Brakkee
25  */
26 public interface Page {
27
28     /**
29      * Gets the content of the page as raw XML. 
30      * @return Page content.
31      */
32     Element getContent();
33     
34     /**
35      * Obtains the links available on the page. 
36      * @return Link names. 
37      */
38     Action[] getActions(); 
39     
40     /**
41      * Gets the named action. Only works if the action name is unique.  
42      * @param aName Name of the action.
43      * @return Action object. 
44      */
45     Action getAction(String aName);
46 }