ReportBuilderOptions

Inheritance: java.lang.Object

public class ReportBuilderOptions

Represents options for the LINQ Reporting Engine functionality.

Constructors

Constructor	Description
ReportBuilderOptions()	Initializes a new instance of this class.

Methods

Method	Description
getKnownTypes()	Gets an unordered set (i.e.
getMissingMemberMessage()	Gets a string value printed instead of a template expression that represents a plain reference to a missing member of an object.
getOptions()	Gets a set of flags controlling behavior of this ReportingEngine instance while building a report.
setMissingMemberMessage(String value)	Sets a string value printed instead of a template expression that represents a plain reference to a missing member of an object.
setOptions(int value)	Sets a set of flags controlling behavior of this ReportingEngine instance while building a report.

ReportBuilderOptions()

public ReportBuilderOptions()

Initializes a new instance of this class.

getKnownTypes()

public KnownTypeSet getKnownTypes()

Gets an unordered set (i.e. a collection of unique items) containing java.lang.Class objects which fully or partially qualified names can be used within report templates processed by this engine instance to invoke the corresponding types’ static members, perform type casts, etc.

Returns: KnownTypeSet - An unordered set (i.e.

getMissingMemberMessage()

public String getMissingMemberMessage()

Gets a string value printed instead of a template expression that represents a plain reference to a missing member of an object. The default value is an empty string.

Remarks:

The property should be used in conjunction with the ReportBuildOptions.ALLOW_MISSING_MEMBERS option. Otherwise, an exception is thrown when a missing member of an object is encountered.

The property affects only printing of a template expression representing a plain reference to a missing object member. For example, printing of a binary operator, one of which operands references a missing object member, is not affected.

The value of this property cannot be set to null.

Returns: java.lang.String - A string value printed instead of a template expression that represents a plain reference to a missing member of an object.

getOptions()

public int getOptions()

Gets a set of flags controlling behavior of this ReportingEngine instance while building a report.

Returns: int - A set of flags controlling behavior of this ReportingEngine instance while building a report. The returned value is a bitwise combination of ReportBuildOptions constants.

setMissingMemberMessage(String value)

public void setMissingMemberMessage(String value)

Sets a string value printed instead of a template expression that represents a plain reference to a missing member of an object. The default value is an empty string.

Remarks:

The property should be used in conjunction with the ReportBuildOptions.ALLOW_MISSING_MEMBERS option. Otherwise, an exception is thrown when a missing member of an object is encountered.

The property affects only printing of a template expression representing a plain reference to a missing object member. For example, printing of a binary operator, one of which operands references a missing object member, is not affected.

The value of this property cannot be set to null.

Parameters:

Parameter	Type	Description
value	java.lang.String	A string value printed instead of a template expression that represents a plain reference to a missing member of an object.

setOptions(int value)

public void setOptions(int value)

Sets a set of flags controlling behavior of this ReportingEngine instance while building a report.

Parameters:

Parameter	Type	Description
value	int	A set of flags controlling behavior of this ReportingEngine instance while building a report. The value must be a bitwise combination of ReportBuildOptions constants.