Package com.caplin.transformer.module

Class ObjectType

java.lang.Object
com.caplin.transformer.module.ObjectType
public class ObjectType extends Object

This class defines all the types of objects that are supported by the Transformer. It contains static instances of the available object types, which can be used to subscribe to data (see Subscriber.addSubscriptionListener), check an updated object's type (see TransformerData.getObjectType) and create a new object (see DSFactory.createTransformerData).

The available object types are:

  • Page
  • Record
  • News
  • Story
  • Type 2 record
  • Type 3 record

  • Field Details

    • PAGE

      public static final ObjectType PAGE

      A page object.

    • RECORD

      public static final ObjectType RECORD

      A record object.

    • NEWS

      public static final ObjectType NEWS

      A news headline object.

    • STORY

      public static final ObjectType STORY

      A news story object.

    • RECORD_TYPE2

      public static final ObjectType RECORD_TYPE2

      A type 2 record object.

    • RECORD_TYPE3

      public static final ObjectType RECORD_TYPE3

      A type 3 record object.

    • CONTAINER

      public static final ObjectType CONTAINER

      A container object.

    • PERMISSION

      public static final ObjectType PERMISSION

      A permission object.

    • UNKNOWN

      public static final ObjectType UNKNOWN

      The object exists but Transformer does not know what type it is yet.

    • GENERIC

      public static final ObjectType GENERIC

      The object does not exist in the Transformer cache.

    • UNDEFINED

      public static final ObjectType UNDEFINED

      The object does not exist in the Transformer cache.

  • Method Details

    • getObjectType

      public static ObjectType getObjectType(int typeCode)

      Gets the ObjectType that represents the specified code.

      The valid codes are:

      Parameters:
      typeCode - The code used to describe an object type.
      Returns:
      The ObjectType that corresponds to the specified code. If the code does not match any of the available ObjectTypes, then null is returned.

    • getCode

      public int getCode()

      Gets the code that represents the object's type.

      Returns:
      The object's code.

    • getDescription

      public String getDescription()

      Gets the description of the object's type.

      Returns:
      The object's description.

    • toString

      public String toString()

      Returns a string that describes the ObjectType, including its description and code.

      Overrides:
      toString in class Object
      Returns:
      A string that represents the ObjectType.

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object