org.xoe.services
Interface IURLViewer

All Superinterfaces:
Constants, IService

public interface IURLViewer
extends IService

IURLViewer provides a service which can take a url and fetch its contents off the web (or locally) and convert it into a renderable XDocument using a IViewableDocumentBuilder. It also provides a convenience method which takes a ContentElement which read the bytes from the ContentElement instead of opening a connection a url.


Field Summary
static String FUNCTIONALITY
           
static String INTERFACE
           
 
Fields inherited from interface org.xoe.core.Constants
ACTION_ATTR, ADD, ADD_APP, AMPERSAND_KEY, AMPERSAND_SYMBOL, AMPERSAND_SYMBOL_STRING, APOSTROPHE_KEY, APOSTROPHE_SYMBOL, ASCENDING_SORT, BACK, BANNER_ATTR, BEEP, BEEP_PROPERTY, CONTEXT_ATTR, COPYRIGHT_KEY, COPYRIGHT_SYMBOL, COUNTRY_PROPERTY, DATA_DOC, DEFAULT_BOOTSTRAP, DEFAULT_NAMESPACE, DEFAULT_THEME, DEFAULT_THEMES_DIR, DEFAULT_VIEW, DELETE, DESCENDING_SORT, DISPLAY, DISPLAY_VIEW, DOCTYPE_NAME_NS_XHTML, DOUBLE_QUOTE_KEY, DOUBLE_QUOTE_SYMBOL, EDIT, EDIT_ITEM_VIEW, EXTENSION_ALL, EXTENSION_DTD, EXTENSION_HTML, EXTENSION_LNK, EXTENSION_WML, EXTENSION_XHTML, EXTENSION_XML, EXTENSION_XOE, EXTENSION_XOE_CONFIG, EXTENSION_ZIP, FEATURE_DOCTYPE_NAME_NS, FEATURE_EXTENSION, FEATURE_MIMETYPE, FILE_PROTOCOL, FORWARD, FUNCTION_CONTENT_HANDLER, GREATER_THAN_KEY, GREATER_THAN_SYMBOL, HIDE_IF_ATTR, HOMEDIR_PROPERTY, HREF_ATTR, INSERT_BEFORE_ATTR, LANGUAGE_PROPERTY, LAUNCH, LESSER_THAN_KEY, LESSER_THAN_SYMBOL, LOADTHEME, LOGGING_PROPERTY, MID_DOT_KEY, MID_DOT_SYMBOL, MIMETYPE_ALL, MIMETYPE_APPLICATION_XOE, MIMETYPE_APPLICATION_ZIP, MIMETYPE_STASHDIR, MIMETYPE_TEXT_HTML, MIMETYPE_TEXT_PLAIN, MIMETYPE_TEXT_VND_TVT_LNK, MIMETYPE_TEXT_WML, MIMETYPE_TEXT_XML, MIMETYPE_TEXT_XML_DTD, MIMETYPE_UNKNOWN, NAME_ATTR, NAMESPACE_SEPARATOR, NEW, NEW_ITEM_VIEW, NO_PATH, NON_BREAKING_SPACE_KEY, NON_BREAKING_SPACE_SYMBOL, NUM_LAST_APPS, ONCHANGE_ATTR, ONCLICK_ATTR, ONKEYPRESS_ATTR, ONLOAD_ATTR, ONMOUSEDOWN_ATTR, ONMOUSEOUT_ATTR, ONMOUSEOVER_ATTR, ONMOUSEUP_ATTR, PACKAGE_ARCHIVE_ROOT, PARENT_FRAME, PKG_ARCHIVE_ATTR, PKG_URI_ATTR, PKG_WORKSPACE_ATTR, PREVIOUS_DIR, PROPERTY_PREFIX, QUERY_DELIMITER, REFRESH, RESET, SAVE, SCREEN_COLORS_PROPERTY, SCREEN_HEIGHT_PROPERTY, SCREEN_TYPE_PROPERTY, SCREEN_WIDTH_PROPERTY, SCRIPT_PROPERTY, SCRIPT_SUPPORT, SELECT, SORT_BANNER_ATTR, SORT_ORDER_ATTR, SRC_ATTR, STASH_DIR_PROPERTY, STASH_FILE_SEPARATOR, STASH_PROTOCOL, STOP, STYLE_ATTR, TEMP_DIR, THEME_PROPERTY, THEMES_DIR_PROPERTY, TOP, TRIGGER_ATTR, UNICODE_DECIMAL_SYMBOL, UNICODE_HEX_SYMBOL, UNKNOWN_ICON, UNSET_NODE_TYPE, URL_CONTEXT_ATTR, USER_NAME, USERDIR_PROPERTY, VALUE_ATTR, WML_NAMESPACE, XHTML_NAMESPACE, XML, XML_PREFIX_NAMESPACE, XMLNS, XMLNS_NAMESPACE, XOE_CONFIG_DOCTYPE_NAME_NS, XOE_LOCALIZE, XPATH_ATTR
 
Method Summary
 org.xoe.core.dom.XDocument getPage(ContentElement content)
          Converts the content data into a renderable XDocument.
 org.xoe.core.dom.XDocument getPage(String src)
          Fetches the url's contents off the web (or locally) and converts it into a renderable XDocument.
 org.xoe.core.dom.XDocument getPage(URL url)
          Fetches the url's contents off the web (or locally) and converts it into a renderable XDocument.
 
Methods inherited from interface org.xoe.core.services.IService
getFeatures, getFunctionalities, getInformation, getInterfaces, init
 

Field Detail

INTERFACE

public static final String INTERFACE

FUNCTIONALITY

public static final String FUNCTIONALITY
Method Detail

getPage

public org.xoe.core.dom.XDocument getPage(String src)
                                   throws IOException
Fetches the url's contents off the web (or locally) and converts it into a renderable XDocument.
Parameters:
src - the source URL
Returns:
a renderable XDocument
Throws:
IOException - if an error occurs while fetching the page

getPage

public org.xoe.core.dom.XDocument getPage(URL url)
                                   throws IOException
Fetches the url's contents off the web (or locally) and converts it into a renderable XDocument.
Parameters:
url - the source URL
Returns:
a renderable XDocument
Throws:
IOException - if an error occurs while fetching the page

getPage

public org.xoe.core.dom.XDocument getPage(ContentElement content)
                                   throws IOException
Converts the content data into a renderable XDocument.
Parameters:
content - the content data
Returns:
a renderable XDocument
Throws:
IOException - if an error occurs