org.apache.myfaces.custom.transform
Class AbstractXmlTransform

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.custom.transform.AbstractXmlTransform

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

XmlTransform

public abstract class AbstractXmlTransform
extends javax.faces.component.UIComponentBase

Transforms XML using and XSL stylesheet. Used to transform XML (from either a String or URL) using either XSLT or Velocity.

Since:

1.1.7

Author:

Sean Schofield

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

AbstractXmlTransform()

Method Summary

void	encodeBegin(javax.faces.context.FacesContext context)
void	encodeChildren(javax.faces.context.FacesContext context)
void	encodeEnd(javax.faces.context.FacesContext context)
abstract java.lang.String	getContent() String containing the XML content to be transformed.
abstract java.lang.String	getContentLocation() String containing the location of the XML content to be transformed.
java.lang.Object	getContentStream() Value binding expression referencing an InputStream from which the XML content is to be read.
java.lang.String	getFamily()
abstract java.lang.String	getStylesheet() String containing the XSL information to use in the transformation.
abstract java.lang.String	getStylesheetLocation() String containing the location of the XSL stylesheet to use in the transformation.
java.lang.Object	getStyleStream() Value binding expression referencing an InputStream from which the XSL stylesheet is to be read.
void	setContentStream(java.lang.Object contentStream)
void	setStyleStream(java.lang.Object styleStream)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

AbstractXmlTransform

public AbstractXmlTransform()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

java.io.IOException

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext context)
                    throws java.io.IOException

Overrides:

encodeChildren in class javax.faces.component.UIComponentBase

Throws:

java.io.IOException

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext context)
               throws java.io.IOException

Overrides:

encodeEnd in class javax.faces.component.UIComponentBase

Throws:

java.io.IOException

getContent

public abstract java.lang.String getContent()

String containing the XML content to be transformed.

getContentLocation

public abstract java.lang.String getContentLocation()

String containing the location of the XML content to be transformed.

getStylesheet

public abstract java.lang.String getStylesheet()

String containing the XSL information to use in the transformation.

setContentStream

public void setContentStream(java.lang.Object contentStream)

getContentStream

public java.lang.Object getContentStream()

Value binding expression referencing an InputStream from which the XML content is to be read.

getStylesheetLocation

public abstract java.lang.String getStylesheetLocation()

String containing the location of the XSL stylesheet to use in the transformation.

setStyleStream

public void setStyleStream(java.lang.Object styleStream)

getStyleStream

public java.lang.Object getStyleStream()

Value binding expression referencing an InputStream from which the XSL stylesheet is to be read.