Package com.inductiveautomation.rm.base

Class 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 Description
      RMSchemaMaker()
      Creates a new schema maker.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getDegreeOfSeparation()
      Returns the degree of separation.
      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​(RXElement anElement)
      Creates and returns a schema for a given xml element tree.
      Schema getSchema​(java.lang.Object anObject, java.lang.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​(java.lang.Class aClass)
      Tells schema maker to ignore any members encountered with the given class.
      void ignoreClass​(java.lang.String aClassName)
      Tells schema maker to ignore any members encountered with the given class (by class name).
      void ignoreMember​(java.lang.Class aClass, java.lang.String aMemberName)
      Tells schema maker to ignore members for a particular class.
      void ignoreMember​(java.lang.String aName)
      Tells schema maker to ignore any members encountered with the given name.
      void ignoreMember​(java.lang.String aClassName, java.lang.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 Detail

      • RMSchemaMaker

        public RMSchemaMaker()
        Creates a new schema maker.

    • Method Detail

      • 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​(java.lang.Class aClass)
        Tells schema maker to ignore any members encountered with the given class.

      • ignoreClass

        public void ignoreClass​(java.lang.String aClassName)
        Tells schema maker to ignore any members encountered with the given class (by class name).

      • ignoreMember

        public void ignoreMember​(java.lang.String aName)
        Tells schema maker to ignore any members encountered with the given name.

      • ignoreMember

        public void ignoreMember​(java.lang.Class aClass,
                         java.lang.String aMemberName)
        Tells schema maker to ignore members for a particular class.

      • ignoreMember

        public void ignoreMember​(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 aDegreeOfSeparation)
        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​(RXElement anElement)
        Creates and returns a schema for a given xml element tree.