com.espertech.esper.client.util
Class XMLRenderingOptions

java.lang.Object
  extended by com.espertech.esper.client.util.XMLRenderingOptions

public class XMLRenderingOptions
extends java.lang.Object

XML rendering options.


Constructor Summary
XMLRenderingOptions()
          Ctor.
 
Method Summary
 EventPropertyRenderer getRenderer()
          Returns the event property renderer to use.
 boolean isDefaultAsAttribute()
          Indicator whether simple properties are rendered as attributes, this setting is false by default thereby simple properties are rendered as elements.
 boolean isPreventLooping()
          Indicator whether to prevent looping, by default set to true.
 XMLRenderingOptions setDefaultAsAttribute(boolean defaultAsAttribute)
          Indicator whether simple properties are rendered as elements (the default) or as attributes, this setting is false by default thereby simple properties are rendered as elements.
 XMLRenderingOptions setPreventLooping(boolean preventLooping)
          Indicator whether to prevent looping, by default set to true.
 void setRenderer(EventPropertyRenderer renderer)
          Sets the event property renderer to use.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLRenderingOptions

public XMLRenderingOptions()
Ctor.

Method Detail

isPreventLooping

public boolean isPreventLooping()
Indicator whether to prevent looping, by default set to true. Set to false to allow looping in the case where nested properties may refer to themselves, for example.

The algorithm to control looping considers the combination of event type and property name for each level of nested property.

Returns:
indicator whether the rendering algorithm prevents looping behavior

isDefaultAsAttribute

public boolean isDefaultAsAttribute()
Indicator whether simple properties are rendered as attributes, this setting is false by default thereby simple properties are rendered as elements.

Returns:
true for simple properties rendered as attributes

setPreventLooping

public XMLRenderingOptions setPreventLooping(boolean preventLooping)
Indicator whether to prevent looping, by default set to true. Set to false to allow looping in the case where nested properties may refer to themselves, for example.

The algorithm to control looping considers the combination of event type and property name for each level of nested property.

Parameters:
preventLooping - indicator whether the rendering algorithm prevents looping behavior
Returns:
options object

setDefaultAsAttribute

public XMLRenderingOptions setDefaultAsAttribute(boolean defaultAsAttribute)
Indicator whether simple properties are rendered as elements (the default) or as attributes, this setting is false by default thereby simple properties are rendered as elements.

Parameters:
defaultAsAttribute - true for simple properties rendered as attributes
Returns:
options object

getRenderer

public EventPropertyRenderer getRenderer()
Returns the event property renderer to use.

Returns:
event property renderer

setRenderer

public void setRenderer(EventPropertyRenderer renderer)
Sets the event property renderer to use.

Parameters:
renderer - event property renderer

© 2006-2015 EsperTech Inc.
All rights reserved.
Visit us at espertech.com