Package com.inductiveautomation.rm.base

Class RMSchemaMaker

java.lang.Object

com.inductiveautomation.rm.base.RMSchemaMaker

public class RMSchemaMaker
extends Object

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

Constructor Summary

Constructors

Constructor	Description
RMSchemaMaker()	Creates a new schema maker.

Method Summary

Modifier and Type	Method	Description
int	getDegreeOfSeparation()	Returns the degree of separation.
boolean	getIncludeFields()	Returns whether to include fields.
void	getProperty(Object aValue, Class aClass, String aKey, int aDepth, Entity anEntity)	Configures a property for a property value.
Schema	getSchema(RXElement anElement)	Creates and returns a schema for a given xml element tree.
Schema	getSchema(Object anObject, String aName, int aDegreeOfSeparation)	This code returns a schema for a given object graph of Java primitives (Map, List, String, Number, Date).
boolean	getUseGetAndIsMethodsOnly()	Returns whether to only use getX/isX accessor methods (as opposed to any method returning a value).
void	ignoreClass(Class aClass)	Tells schema maker to ignore any members encountered with the given class.
void	ignoreClass(String aClassName)	Tells schema maker to ignore any members encountered with the given class (by class name).
void	ignoreMember(Class aClass, String aMemberName)	Tells schema maker to ignore members for a particular class.
void	ignoreMember(String aName)	Tells schema maker to ignore any members encountered with the given name.
void	ignoreMember(String aClassName, String aMemberName)	Tells schema maker to ignore members for a particular class name.
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

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

Constructor Details

RMSchemaMaker

public RMSchemaMaker()

Creates a new schema maker.

Method Details

getDegreeOfSeparation

public int getDegreeOfSeparation()

Returns the degree of separation.

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.

ignoreClass

public void ignoreClass(Class aClass)

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

ignoreClass

public void ignoreClass(String aClassName)

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

ignoreMember

public void ignoreMember(String aName)

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

ignoreMember

public void ignoreMember(Class aClass,
 String aMemberName)

Tells schema maker to ignore members for a particular class.

ignoreMember

public void ignoreMember(String aClassName,
 String aMemberName)

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

getSchema

public Schema getSchema(Object anObject,
 String aName,
 int aDegreeOfSeparation)

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

getProperty

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

Configures a property for a property value.

getSchema

public Schema getSchema(RXElement anElement)

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