(no commit message)

[utils] / crawler / basic / src / org / wamblee / crawler / Page.java

diff --git a/crawler/basic/src/org/wamblee/crawler/Page.java b/crawler/basic/src/org/wamblee/crawler/Page.java
new file mode 100644 (file)
index 0000000..18cf37a
--- /dev/null
+++ b/crawler/basic/src/org/wamblee/crawler/Page.java
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2005 the original author or authors.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ 
+
+package org.wamblee.crawler;
+
+import org.dom4j.Element;
+
+/**
+ * Represents a retrieved page. 
+ */
+public interface Page {
+
+    /**
+     * Gets the content of the page as raw XML. 
+     * @return Page content.
+     */
+    Element getContent();
+    
+    /**
+     * Obtains the links available on the page. 
+     * @return Link names. 
+     */
+    Action[] getActions(); 
+    
+    /**
+     * Gets the named action. Only works if the action name is unique.  
+     * @param aName Name of the action.
+     * @return Action object. 
+     */
+    Action getAction(String aName);
+}