ilog.views.chart.faces.component.data

Class IlvFacesJDBCDataSource

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

ilog.views.faces.component.IlvFacesComponentBase

ilog.views.chart.faces.component.data.IlvFacesDataSource

ilog.views.chart.faces.component.data.IlvFacesJDBCDataSource

All Implemented Interfaces:

IlvFacesComponent, IlvFacesConstants, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, Serializable, EventListener

public class IlvFacesJDBCDataSource
extends IlvFacesDataSource

A data source that wraps an IlvJDBCDataSource. This kind of data source loads its data from a database.
There are two ways to use this component:

• Specify the connection parameters: user, password, driver, query, URL. The data source will create the connection to load its data with these parameters.
• Set a result set. The data source will use this result set to load its data.

Since:

JViews 6.5

See Also:

Serialized Form

Field Summary

Fields inherited from class jakarta.faces.component.UIComponent

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

Fields inherited from interface ilog.views.faces.IlvFacesConstants

AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_BUNDLE, MENU_MODEL_ID, MESSAGE, MESSAGE_BOX, MESSAGE_BOX_ID, MOVE_ALLOWED, OBJECT_FINDER, PARAM_COMPID, PARAM_DATA, PARAM_KEY, PARAM_NAMESPACE, PARAM_RESOURCE, PARAM_SERVICE, PARAM_TYPE, POPUP_MENU, POPUP_MENU_FACTORY, POPUP_MENU_FACTORY_CLASS, PORTLET_NAMESPACE, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvFacesJDBCDataSource() Creates a new IlvFacesJDBCDataSource instance.

Method Summary

Modifier and Type	Method and Description
static String	getComponentType() Returns the type of this component.
String	getDriver() Returns the JDBC driver class name.
String	getFamily() Returns the family of this component.
String	getPassword() Returns the user password.
String	getQuery() Returns the query.
ResultSet	getResultSet() Returns the result set.
String	getUrl() Returns the database URL.
String	getUser() Returns the user name.
void	restoreState(jakarta.faces.context.FacesContext context, Object stateObj) Perform any processing required to restore the state from the entries in the state Object.
Object	saveState(jakarta.faces.context.FacesContext context) Gets the state of the instance as a Serializable Object.
void	setDriver(String driver) Sets The JDBC driver classname to load.
void	setPassword(String password) Sets the user password.
void	setQuery(String query) Sets the query.
void	setResultSet(ResultSet resultSet) Sets the result set to use.
void	setUrl(String url) Sets the database URL.
void	setUser(String user) Sets the user name.
void	updateModel(jakarta.faces.context.FacesContext context) Handles the "Update Model Values" phase of the JSF life cycle.

Methods inherited from class ilog.views.chart.faces.component.data.IlvFacesDataSource

getValue, isRefreshData, setRefreshData, setValue

Methods inherited from class ilog.views.faces.component.IlvFacesComponentBase

clearDecodedPropertyMap, createFacesComponent, getAttributes, getClientId, isDecodedProperty, processUpdates, resetDecodedProperties, setDecodedProperty

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvFacesJDBCDataSource

public IlvFacesJDBCDataSource()

Creates a new IlvFacesJDBCDataSource instance.

Method Detail

getFamily

public String getFamily()

Returns the family of this component.

Overrides:

getFamily in class IlvFacesDataSource

Returns:

the family of this component.

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.

getDriver

public String getDriver()

Returns the JDBC driver class name.

Returns:

The JDBC driver class name.

setDriver

public void setDriver(String driver)

Sets The JDBC driver classname to load.

Parameters:

driver - The JDBC driver classname to use.

getPassword

public String getPassword()

Returns the user password.

setPassword

public void setPassword(String password)

Sets the user password.

getUrl

public String getUrl()

Returns the database URL.

setUrl

public void setUrl(String url)

Sets the database URL.

Parameters:

url - The database URL. This string should be formatted according to the database specifications.

getUser

public String getUser()

Returns the user name.

Returns:

The user name.

setUser

public void setUser(String user)

Sets the user name.

Parameters:

user - The user name.

getResultSet

public ResultSet getResultSet()

Returns the result set.

Returns:

The result set.

See Also:

setResultSet(ResultSet)

setResultSet

public void setResultSet(ResultSet resultSet)

Sets the result set to use. If this property is set, the other ones are not used.

Parameters:

resultSet - The result set to use in this data source.

getQuery

public String getQuery()

Returns the query.

setQuery

public void setQuery(String query)

Sets the query.

Parameters:

query - The query to the JDBC data source.

updateModel

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

Handles the "Update Model Values" phase of the JSF life cycle. This method updates the referenced values with the local values of the component if theses values were updated during the "Apply Request Values" phase.

Overrides:

updateModel in class IlvFacesComponentBase

Parameters:

context - The current faces context.

saveState

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

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the IlvFacesComponentBase.saveState(jakarta.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets.

This method must not alter the state of the implementing object. In other words, after executing this code:

 Object state = component.saveState(facesContext);
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface jakarta.faces.component.StateHolder

Overrides:

saveState in class IlvFacesComponentBase

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(jakarta.faces.context.FacesContext context,
                         Object stateObj)

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the IlvFacesComponentBase.restoreState(jakarta.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface jakarta.faces.component.StateHolder

Overrides:

restoreState in class IlvFacesComponentBase

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.