Package com.im.ijc.core.api.cookie

Interface SchemaProviderCookie

  • All Superinterfaces:
    com.im.df.api.ddl.DFCapability, org.openide.nodes.Node.Cookie
    public interface SchemaProviderCookie
extends org.openide.nodes.Node.Cookie, com.im.df.api.ddl.DFCapability
    Cookie providing the root DIF model interface - DFSchemaProvider

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  SchemaProviderCookie.EncryptionSupport
      Optional interface, which makes the schema open to ask for an extra password for decrypting some properties.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.openide.loaders.DataObject getDataObject()
      Returns the schemaDataObject.
      com.im.df.impl.db.api.DBImplSchemaProvider.PropsProvider getPropsProvider()
      Return properties provider.
      com.im.df.api.DFSchemaProvider getSchemaProvider​(boolean forceInit)
      Get schema provider instance.
      com.im.df.api.SchemaType getSchemaType()
      Determines if the schema is local, stored within the project, or in remote database, or schema is accessed through IJC application server
      boolean isAutoConnect()
      Should this schema be connected automatically after startup or project opening?

    • Method Detail

      • getSchemaProvider

        com.im.df.api.DFSchemaProvider getSchemaProvider​(boolean forceInit)
        Get schema provider instance. The schema provider can return in any state (uninitialized of completely finished). This call in not blocking, initializer runs on background. If unitialized schemaprovider is returned (=state.isSchemaReady() returns false) then it's possible to register property change listener for PROP_STATE and check when schema is ready.
        Parameters:
        forceInit - If true, it starts async process for schema initialization

      • getDataObject

        org.openide.loaders.DataObject getDataObject()
        Returns the schemaDataObject. Svata: we should avoid having SchemaDO in the APIs. SchemaDO does not provide any APIs, so it is not necessary to use specific type.

      • getPropsProvider

        com.im.df.impl.db.api.DBImplSchemaProvider.PropsProvider getPropsProvider()
        Return properties provider. This object can be used for writing/reading of properties in the file under this cookie (=DataObject)

      • getSchemaType

        com.im.df.api.SchemaType getSchemaType()
        Determines if the schema is local, stored within the project, or in remote database, or schema is accessed through IJC application server
        Returns:
        The type of the schema

      • isAutoConnect

        boolean isAutoConnect()
        Should this schema be connected automatically after startup or project opening?
        Returns:
        True if schema should be connected automatically