org.xoe.core.content
Class ContentElement

java.lang.Object
  |
  +--org.xoe.core.dom.XNode
        |
        +--org.xoe.core.dom.ParentNode
              |
              +--org.xoe.core.dom.XElement
                    |
                    +--org.xoe.core.content.ContentElement
All Implemented Interfaces:
org.xoe.core.dom.Cacheable, Cloneable, Constants, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList
Direct Known Subclasses:
org.xoe.core.content.FileContentElement

public class ContentElement
extends org.xoe.core.dom.XElement

The ContentElement class represents the atomic unit of content handling in the XOE system.
All content used by the system, whether local or on the Web, is at some point in it's lifecycle managed as an instance of this class.


Field Summary
protected  Date lastModified
          the date this object was last modified
 
Fields inherited from class org.xoe.core.dom.XNode
callbacks
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
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
 void clearCachedData()
           
 org.w3c.dom.Node cloneNode(boolean deep)
           
static String encodeName(String s)
          Returns a string which is the encoded representation of the string passed in.
 int getContentLength()
          Returns the size of the data associated with this content.
 InputStream getInputStream()
          Returns the InputStream associated with this content.
 Date getLastModified()
          Returns the date this object was last changed
 ContentType getType()
          Returns the type of the data associated with this content.
 URL getURL()
          Returns the URL associated with this content.
protected  void setLength(long len)
          Sets the size of the data associated with this content.
 
Methods inherited from class org.xoe.core.dom.XElement
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getElementsByTagName, getElementsByTagNameNS, getLocalName, getNamespaceURI, getNodeName, getNodeType, getPrefix, getTagName, hasAttribute, hasAttributeNS, hasAttributes, normalize, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setNodeName, setPrefix
 
Methods inherited from class org.xoe.core.dom.ParentNode
appendChild, getChildNodes, getFirstChild, getLastChild, getLength, hasChildNodes, insertBefore, item, removeChild, replaceChild, reset
 
Methods inherited from class org.xoe.core.dom.XNode
getCallback, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, isSupported, setCallback, setNodeValue, setParentNode, supports, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.w3c.dom.Node
appendChild, getChildNodes, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, isSupported, removeChild, replaceChild, setNodeValue
 

Field Detail

lastModified

protected Date lastModified
the date this object was last modified
Method Detail

getURL

public URL getURL()
Returns the URL associated with this content.
Returns:
the URL associated with this content

clearCachedData

public void clearCachedData()

getInputStream

public InputStream getInputStream()
                           throws IOException
Returns the InputStream associated with this content.
Returns:
the InputStream associated with this content
Throws:
IOException - if an I/O error occurs

setLength

protected void setLength(long len)
Sets the size of the data associated with this content.
Parameters:
len - the size, in bytes, of the content's data

getContentLength

public int getContentLength()
Returns the size of the data associated with this content.
Returns:
the size, in bytes, of the associated content's data; 0 if there is an error

getType

public ContentType getType()
                    throws IOException
Returns the type of the data associated with this content.
Returns:
the type of the data associated with this content

getLastModified

public Date getLastModified()
Returns the date this object was last changed
Returns:
the date this object was last changed

encodeName

public static String encodeName(String s)
Returns a string which is the encoded representation of the string passed in. Used to encode filenames that may not be legal element names according to the DOM spec.
Parameters:
s - a string representing the name to be encoded
Returns:
the encoded string

cloneNode

public org.w3c.dom.Node cloneNode(boolean deep)
Overrides:
cloneNode in class org.xoe.core.dom.XElement