net.sf.jasperreports.jsf.component
Class UISource

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          net.sf.jasperreports.jsf.component.UISource

All Implemented Interfaces:

javax.faces.component.StateHolder

public class UISource
extends javax.faces.component.UIComponentBase

Faces component (non-rendered) used to feed the report with external data.

Author:

A. Alonso Dominguez

Field Summary

static String	COMPONENT_FAMILY Specific family name used with report sources.
static String	COMPONENT_TYPE Specific component type name.

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

UISource()
Instantiates a new data source.

Method Summary

void	decodeValue(javax.faces.context.FacesContext context)
protected void	executeValidate(javax.faces.context.FacesContext context)
SourceConverter	getConverter() Obtains the SourceConverter instance.
String	getFamily()
protected JRFacesContext	getJRFacesContext() Obtains the current JRFacesContext instance.
String	getQuery() Gets the query.
Source	getSubmittedSource()
String	getType() Gets the type.
javax.faces.validator.Validator	getValidator()
Object	getValue() Gets the value.
boolean	isValid() Checks if this source configuration is valid.
void	processDecodes(javax.faces.context.FacesContext context)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
void	resetValue()
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.FacesContext context)
void	setConverter(SourceConverter converter) Establishes a new SourceConverter instance.
void	setQuery(String query) Sets the query.
void	setSubmittedSource(Source submittedSource)
void	setType(String type) Sets the type.
protected void	setValid(boolean valid) Establishes a new value for the valid state.
void	setValidator(javax.faces.validator.Validator validator)
void	setValue(Object value) Sets the value.
void	updateModel(javax.faces.context.FacesContext context)
void	validate(javax.faces.context.FacesContext context)

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId, getValueExpression, setValueExpression

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

Specific family name used with report sources.

COMPONENT_TYPE

public static final String COMPONENT_TYPE

Specific component type name.

Constructor Detail

UISource

public UISource()

Instantiates a new data source.

Method Detail

getQuery

public final String getQuery()

Gets the query.

Returns:

the query

setQuery

public final void setQuery(String query)

Sets the query.

Parameters:

query - the new query

getType

public final String getType()

Gets the type.

Returns:

the type

setType

public final void setType(String type)

Sets the type.

Parameters:

type - the new type

isValid

public final boolean isValid()

Checks if this source configuration is valid.

Returns:

if this source instance is valid.

setValid

protected final void setValid(boolean valid)

Establishes a new value for the valid state.

Parameters:

valid - new valid value.

getValue

public final Object getValue()

Gets the value.

Returns:

the value

setValue

public final void setValue(Object value)

Sets the value.

Parameters:

value - the new value

getConverter

public final SourceConverter getConverter()

Obtains the SourceConverter instance.

Returns:

current SourceConverter instance.

setConverter

public final void setConverter(SourceConverter converter)

Establishes a new SourceConverter instance.

Parameters:

converter - the new SourceConverter instance.

getValidator

public javax.faces.validator.Validator getValidator()

setValidator

public void setValidator(javax.faces.validator.Validator validator)

getSubmittedSource

public Source getSubmittedSource()

setSubmittedSource

public void setSubmittedSource(Source submittedSource)

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

resetValue

public void resetValue()

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class javax.faces.component.UIComponentBase

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class javax.faces.component.UIComponentBase

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class javax.faces.component.UIComponentBase

decodeValue

public void decodeValue(javax.faces.context.FacesContext context)

updateModel

public void updateModel(javax.faces.context.FacesContext context)

validate

public void validate(javax.faces.context.FacesContext context)
              throws javax.faces.validator.ValidatorException

Throws:

javax.faces.validator.ValidatorException

executeValidate

protected void executeValidate(javax.faces.context.FacesContext context)
                        throws javax.faces.validator.ValidatorException

Throws:

javax.faces.validator.ValidatorException

getJRFacesContext

protected final JRFacesContext getJRFacesContext()

Obtains the current JRFacesContext instance.

Returns:

current JRFacesContext instance.