Interface Schema

  • All Implemented Interfaces:

    
    public interface Schema
    
                        

    Interface representing an XDM Event Data schema.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract String getSchemaVersion() Returns the version of this schema as defined in the Adobe Experience Platform.
      abstract String getSchemaIdentifier() Returns the identifier for this schema as defined in the Adobe Experience Platform.
      abstract String getDatasetIdentifier() Returns the identifier for this dataset as defined in the Adobe Experience Platform.
      abstract Map<String, Object> serializeToXdm() Serialize this Schema object to a map equivalent of its XDM schema.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getSchemaVersion

         abstract String getSchemaVersion()

        Returns the version of this schema as defined in the Adobe Experience Platform.

        Returns:

        the version of this schema

      • getSchemaIdentifier

         abstract String getSchemaIdentifier()

        Returns the identifier for this schema as defined in the Adobe Experience Platform. The identifier is a URI where this schema is defined.

        Returns:

        the URI identifier for this schema

      • getDatasetIdentifier

         abstract String getDatasetIdentifier()

        Returns the identifier for this dataset as defined in the Adobe Experience Platform.

        Returns:

        the dataset ID

      • serializeToXdm

         abstract Map<String, Object> serializeToXdm()

        Serialize this Schema object to a map equivalent of its XDM schema.

        Returns:

        XDM formatted map of this Schema object