ilog.views.diagrammer.faces.component.data

Class IlvFacesDiagrammerXMLDataSource

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

ilog.views.faces.component.IlvFacesComponentBase

ilog.views.diagrammer.faces.component.data.IlvFacesDiagrammerDataSource

ilog.views.diagrammer.faces.component.data.IlvFacesDiagrammerXMLDataSource

All Implemented Interfaces:

IlvFacesDiagrammerConstants, 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 IlvFacesDiagrammerXMLDataSource
extends IlvFacesDiagrammerDataSource

A diagrammer data source that read XML data files. This component wraps IlvXMLDataSource instance.

Since:

JViews 6.5

See Also:

IlvXMLDataSource, 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.diagrammer.faces.IlvFacesDiagrammerConstants

DASHBOARD_DIAGRAM, DATA_SOURCE, DATA_SOURCE_ID, DATA_URL, DIAGRAMMER, EDITABLE, INPUT_XSL, OUTPUT_XSL, PARAM_CSS, PARAM_XML, PROPERTY_ACCESSOR, STYLE_SHEETS

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
IlvFacesDiagrammerXMLDataSource() Creates a new IlvFacesDiagrammerXMLDataSource instance.

Method Summary

Modifier and Type	Method and Description
void	clearInputParameters() Clears the parameters to pass to the input XSL transform.
void	clearOutputParameters() Clears the parameters to pass to the output XSL transform.
static String	getComponentType() Returns the type of this component.
String	getDataURL() Returns the URL of the XML data file.
String	getFamily()
String	getInputXSL() Returns the URL of the input XSL file.
String	getOutputXSL() Returns the URL of the output XSL file.
IlvXMLDataSource	getXMLDataSource() Returns the wrapped IlvXMLDataSource instance.
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	setDataURL(String dataURL) Sets the URL of the XML data file.
void	setInputParameter(String name, Object value) Sets a parameter for the input XSL transform.
void	setInputXSL(String inputXSL) Sets the URL of the input XSL file.
void	setOutputParameter(String name, Object value) Sets an input parameter for the output XSL transform.
void	setOutputXSL(String outputXSL) Sets the URL of the output XSL file.
void	updateModel(jakarta.faces.context.FacesContext context) Handles the "Update Model Values" phase of the JSF life cycle.

Methods inherited from class ilog.views.diagrammer.faces.component.data.IlvFacesDiagrammerDataSource

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

IlvFacesDiagrammerXMLDataSource

public IlvFacesDiagrammerXMLDataSource()

Creates a new IlvFacesDiagrammerXMLDataSource instance.

Method Detail

getXMLDataSource

public IlvXMLDataSource getXMLDataSource()

Returns the wrapped IlvXMLDataSource instance.

Returns:

The wrapped IlvXMLDataSource instance.

getFamily

public String getFamily()

Overrides:

getFamily in class IlvFacesDiagrammerDataSource

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.

getDataURL

public String getDataURL()

Returns the URL of the XML data file.

Returns:

The data URL.

setDataURL

public void setDataURL(String dataURL)
                throws MalformedURLException

Sets the URL of the XML data file.

Parameters:

dataURL - The data URL to set.

Throws:

MalformedURLException

getInputXSL

public String getInputXSL()

Returns the URL of the input XSL file.

Returns:

The input XSL.

setInputXSL

public void setInputXSL(String inputXSL)
                 throws MalformedURLException

Sets the URL of the input XSL file. The XSL input file must be null to read XML in the SDM format.

Parameters:

inputXSL - The input XSL to set.

Throws:

MalformedURLException

getOutputXSL

public String getOutputXSL()

Returns the URL of the output XSL file.

Returns:

The output XSL.

setOutputXSL

public void setOutputXSL(String outputXSL)
                  throws MalformedURLException

Sets the URL of the output XSL file. The XSL output file must be null to write XML in the SDM format.

Parameters:

outputXSL - The output XSL to set.

Throws:

MalformedURLException

setInputParameter

public void setInputParameter(String name,
                              Object value)

Sets a parameter for the input XSL transform.

Parameters:

name - The name of the parameter to be set.

value - The value of the parameter to be set.

setOutputParameter

public void setOutputParameter(String name,
                               Object value)

Sets an input parameter for the output XSL transform.

Parameters:

name - The name of the parameter to be set.

value - The value of the parameter to be set.

clearInputParameters

public void clearInputParameters()

Clears the parameters to pass to the input XSL transform.

clearOutputParameters

public void clearOutputParameters()

Clears the parameters to pass to the output XSL transform.

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.