com.reportmill.base

Class RMSchemaMaker

java.lang.Object

com.reportmill.base.RMSchemaMaker

public class RMSchemaMaker
extends java.lang.Object

This class makes a schema from an object graph, given a top level object.

Constructor Summary

Constructors

Constructor and Description
RMSchemaMaker() Creates a new schema maker.

Method Summary

Modifier and Type	Method and Description
void	addIgnoreClass(java.lang.Class aClass) Tells schema maker to ignore any members encountered with the given class.
void	addIgnoreClass(java.lang.String aClassName) Tells schema maker to ignore any members encountered with the given class (by class name).
void	addIgnoreMember(java.lang.Class aClass, java.lang.String aMemberName) Tells schema maker to ignore members for a particular class.
void	addIgnoreMember(java.lang.String aName) Tells schema maker to ignore any members encountered with the given name.
void	addIgnoreMember(java.lang.String aClassName, java.lang.String aMemberName) Tells schema maker to ignore members for a particular class name.
int	getBreadthLimit() Returns the maximum number of items to write for lists/array relationships.
int	getDepthLimit() Returns the limit of recursion for relationships.
boolean	getIncludeFields() Returns whether to include fields.
void	getProperty(java.lang.Object aValue, java.lang.Class aClass, java.lang.String aKey, int aDepth, Entity anEntity) Configures a property for a property value.
Schema	getSchema(java.lang.Object anObject, java.lang.String aName, int aDepthLimit) This code returns a schema for a given object graph of Java primitives (Map, List, String, Number, Date).
Schema	getSchema(XMLElement anElement) Creates and returns a schema for a given xml element tree.
boolean	getUseGetAndIsMethodsOnly() Returns whether to only use getX/isX accessor methods (as opposed to any method returning a value).
void	setBreadthLimit(int aLimit) Sets the maximum number of items to write for lists/array relationships.
void	setIncludeFields(boolean aFlag) Sets whether to include fields.
void	setUseGetAndIsMethodsOnly(boolean aFlag) Sets whether to only use getX/isX accessor methods (as opposed to any method returning a value).

Methods inherited from class java.lang.Object

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

Constructor Detail

RMSchemaMaker

public RMSchemaMaker()

Creates a new schema maker.

Method Detail

getDepthLimit

public int getDepthLimit()

Returns the limit of recursion for relationships.

getBreadthLimit

public int getBreadthLimit()

Returns the maximum number of items to write for lists/array relationships.

setBreadthLimit

public void setBreadthLimit(int aLimit)

Sets the maximum number of items to write for lists/array relationships.

getUseGetAndIsMethodsOnly

public boolean getUseGetAndIsMethodsOnly()

Returns whether to only use getX/isX accessor methods (as opposed to any method returning a value).

setUseGetAndIsMethodsOnly

public void setUseGetAndIsMethodsOnly(boolean aFlag)

Sets whether to only use getX/isX accessor methods (as opposed to any method returning a value).

getIncludeFields

public boolean getIncludeFields()

Returns whether to include fields.

setIncludeFields

public void setIncludeFields(boolean aFlag)

Sets whether to include fields.

addIgnoreClass

public void addIgnoreClass(java.lang.Class aClass)

Tells schema maker to ignore any members encountered with the given class.

addIgnoreClass

public void addIgnoreClass(java.lang.String aClassName)

Tells schema maker to ignore any members encountered with the given class (by class name).

addIgnoreMember

public void addIgnoreMember(java.lang.String aName)

Tells schema maker to ignore any members encountered with the given name.

addIgnoreMember

public void addIgnoreMember(java.lang.Class aClass,
                            java.lang.String aMemberName)

Tells schema maker to ignore members for a particular class.

addIgnoreMember

public void addIgnoreMember(java.lang.String aClassName,
                            java.lang.String aMemberName)

Tells schema maker to ignore members for a particular class name.

getSchema

public Schema getSchema(java.lang.Object anObject,
                        java.lang.String aName,
                        int aDepthLimit)

This code returns a schema for a given object graph of Java primitives (Map, List, String, Number, Date).

getProperty

public void getProperty(java.lang.Object aValue,
                        java.lang.Class aClass,
                        java.lang.String aKey,
                        int aDepth,
                        Entity anEntity)

Configures a property for a property value.

getSchema

public Schema getSchema(XMLElement anElement)

Creates and returns a schema for a given xml element tree.