Package de.uplanet.lucy.server.usermanager.ds

Class DsDbSchema

java.lang.Object
de.uplanet.lucy.server.usermanager.ds.DsDbSchema
@Scriptable public final class DsDbSchema extends Object

  • Method Summary

    Modifier and Type
    Method
    Description
    static List<de.uplanet.lucy.server.usermanager.ds.DsClass>
    getAllDerivedClasses(int p_iClass)
    Get a list of classes that are derived from the given class (contains the given class).
    static List<de.uplanet.lucy.server.usermanager.ds.DsClass>
    getAllDerivedClasses(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
    gets a list of classes that are derived from the class (contains the given class)
    static List<de.uplanet.lucy.server.usermanager.ds.DsClass>
    getAllDerivedClasses(String p_strClassName)
    gets a list of classes that are derived from the class (contains the given class)
    static String
    getAttributeGuidForName(String p_strName)
     
    static String
    getAttributeNameForGuid(String p_strGuid)
     
    static de.uplanet.lucy.server.usermanager.ds.DsClass
    getDSClassDefinition(int p_iClassID)
     
    static de.uplanet.lucy.server.usermanager.ds.DsClass
    getDSClassDefinition(String p_strClass)
     
    static de.uplanet.lucy.server.usermanager.ds.DsClass
    getDSClassDefinitionByGuid(String p_strGuid)
     
    static Map<String,de.uplanet.lucy.server.usermanager.ds.DsClass>
    getDSClassDefinitions()
     
    static boolean
    isArrayAttribute(String p_strGuid)
    checks if the given guid is an array attribute
    static boolean
    isDerivedFrom(int p_iSuperClass, int p_iClass)
    Returns true, when the type is derived from the super type.
    static boolean
    isDerivedFrom(de.uplanet.lucy.server.usermanager.ds.DsClass p_srcClass, de.uplanet.lucy.server.usermanager.ds.DsClass p_dstClass)
    Returns true, when p_checkType is derived from the p_iSrcType.
    static boolean
    isDerivedFrom(String p_strSrcTypeName, String p_strDestTypeName)
    Returns true, when p_checkType is derived from the p_iSrcType.
    static boolean
    isDerivedFromContainer(int p_iClassId)
    return true if p_iClass is derived from a container
    static boolean
    isDerivedFromContainer(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
    return true if p_class is derived from a container
    static boolean
    isDerivedFromContainer(String p_strClass)
    return true if p_strClass is derived from a container
    static boolean
    isDerivedFromSet(int p_iClassId)
    Return true if p_class is derived from a set.
    static boolean
    isDerivedFromSet(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
    true if p_class is derived from a set
    static boolean
    isDerivedFromSet(String p_strClass)
    Return true if p_strClass is derived from a set.
    static boolean
    isDerivedFromUser(int p_iClassId)
    Check if the given class is derived from the user class.
    static boolean
    isDerivedFromUser(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
    Check if the given class is derived from the user class.
    static boolean
    isDerivedFromUser(String p_strClass)
    Check if the given class is derived from the user class.
    static boolean
    isNoContainer(int p_iClassID)
    true if p_class is not derived from a container or a set
    static boolean
    isNoContainer(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
    true if p_class is not derived from a container
    static boolean
    isNoContainer(String p_strClass)
    true if p_strClass is not derived from a container or a set
    static boolean
    isNoContainerOrSet(int p_iClassID)
    true if p_iClassID is not derived from a container or a set
    static boolean
    isNoContainerOrSet(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
    true if p_class is not derived from a container or a set
    static boolean
    isNoContainerOrSet(String p_strClass)
    true if p_strClass is not derived from a container or a set
    static boolean
    isNoSet(int p_iClassID)
    true if p_class is not derived from a set
    static boolean
    isNoSet(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
    true if p_class is not derived from a set
    static boolean
    isNoSet(String p_strClass)
    true if p_strClass is not derived from a set
    static boolean
    isTenantAttributeDefined()
    Is a attribute defined as tenant ID in this schema?
    static String
    mapClassIdToClassKey(int p_iID)
     
    static int
    mapClassKeyToClassId(String p_strKey)
     
    static void
    refreshCache(de.uplanet.jdbc.JdbcConnection p_conn)
    reloads the cache.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • refreshCache

      public static void refreshCache(de.uplanet.jdbc.JdbcConnection p_conn) throws SQLException
      reloads the cache.
      Parameters:
      p_conn - The database connection
      Throws:
      SQLException

    • getDSClassDefinition

      public static de.uplanet.lucy.server.usermanager.ds.DsClass getDSClassDefinition(int p_iClassID)
      Parameters:
      p_iClassID - The pk value of the DSClass Table (LID)
      Returns:
      The class with the given id (could be null)

    • getDSClassDefinition

      public static de.uplanet.lucy.server.usermanager.ds.DsClass getDSClassDefinition(String p_strClass)
      Parameters:
      p_strClass - The unique class name
      Returns:
      The dsclass object or null if not found.

    • getDSClassDefinitionByGuid

      public static de.uplanet.lucy.server.usermanager.ds.DsClass getDSClassDefinitionByGuid(String p_strGuid)
      Parameters:
      p_strGuid - The class guid
      Returns:
      The dsclass object or null if not found.

    • getDSClassDefinitions

      public static Map<String,de.uplanet.lucy.server.usermanager.ds.DsClass> getDSClassDefinitions()
      Returns:
      An unmodifiable map of class definitions.

    • isDerivedFrom

      public static boolean isDerivedFrom(int p_iSuperClass, int p_iClass)
      Returns true, when the type is derived from the super type.
      Parameters:
      p_iSuperClass - if not exists a DsRuntimeException is thrown
      p_iClass - if not exists false is returned
      Returns:
      true if p_iDstType is derived from p_iSrcType.

    • getAllDerivedClasses

      public static List<de.uplanet.lucy.server.usermanager.ds.DsClass> getAllDerivedClasses(int p_iClass)
      Get a list of classes that are derived from the given class (contains the given class).
      Parameters:
      p_iClass - the type of the class. If no class will be found for that id an DsRuntimeException will be thrown.
      Returns:
      a list of derived classes, contains the src class.

    • getAllDerivedClasses

      public static List<de.uplanet.lucy.server.usermanager.ds.DsClass> getAllDerivedClasses(String p_strClassName)
      gets a list of classes that are derived from the class (contains the given class)
      Parameters:
      p_strClassName - the type of the class. If no class will be found for that name an IllegalArgumentException will be thrown.
      Returns:
      a list of derived classes, contains the src class.

    • getAllDerivedClasses

      public static List<de.uplanet.lucy.server.usermanager.ds.DsClass> getAllDerivedClasses(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
      gets a list of classes that are derived from the class (contains the given class)
      Parameters:
      p_class - the ds class.
      Returns:
      a list of derived classes, contains the src class.

    • getAttributeNameForGuid

      public static String getAttributeNameForGuid(String p_strGuid)
      Parameters:
      p_strGuid - guid of the attribute (DSATTRIBUTE.STRGUID column)
      Returns:
      name of the attribute given by the guid, or null if not found

    • getAttributeGuidForName

      public static String getAttributeGuidForName(String p_strName)
      Parameters:
      p_strName - name of the attribute (DSATTRIBUTE.STRNAME column)
      Returns:
      name of the attribute given by the guid, or null if not found

    • isDerivedFrom

      public static boolean isDerivedFrom(String p_strSrcTypeName, String p_strDestTypeName)
      Returns true, when p_checkType is derived from the p_iSrcType.
      Parameters:
      p_strSrcTypeName - if null true is returned, if not exists a DsRuntimeException is thrown
      p_strDestTypeName - if null or not exists then false is returned
      Returns:
      true if p_strDstTypeName is derived type o p_strSrcTypeName

    • isDerivedFrom

      public static boolean isDerivedFrom(de.uplanet.lucy.server.usermanager.ds.DsClass p_srcClass, de.uplanet.lucy.server.usermanager.ds.DsClass p_dstClass)
      Returns true, when p_checkType is derived from the p_iSrcType.
      Parameters:
      p_srcClass - if null always true is returned
      p_dstClass - if null always falseis returned
      Returns:
      true

    • isDerivedFromSet

      public static boolean isDerivedFromSet(int p_iClassId)
      Return true if p_class is derived from a set.
      Parameters:
      p_iClassId - The class id
      Returns:
      true the class is derived from a set

    • isDerivedFromSet

      public static boolean isDerivedFromSet(String p_strClass)
      Return true if p_strClass is derived from a set.
      Parameters:
      p_strClass - The class type name
      Returns:
      true the p_strClass is derived from a set.

    • isDerivedFromSet

      public static boolean isDerivedFromSet(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
      true if p_class is derived from a set
      Parameters:
      p_class - The class object
      Returns:
      true if p_class is derived from a set.

    • isDerivedFromContainer

      public static boolean isDerivedFromContainer(int p_iClassId)
      return true if p_iClass is derived from a container
      Parameters:
      p_iClassId - The class id
      Returns:
      true if derived from the container class

    • isDerivedFromContainer

      public static boolean isDerivedFromContainer(String p_strClass)
      return true if p_strClass is derived from a container
      Parameters:
      p_strClass - The class type name
      Returns:
      true if derived from the container class

    • isDerivedFromContainer

      public static boolean isDerivedFromContainer(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
      return true if p_class is derived from a container
      Parameters:
      p_class - The class object
      Returns:
      true if derived from the container class

    • isDerivedFromUser

      public static boolean isDerivedFromUser(int p_iClassId)
      Check if the given class is derived from the user class.
      Parameters:
      p_iClassId - The integer class identifier.
      Returns:
      true if the given class is derived from the user class, or false otherwise.

    • isDerivedFromUser

      public static boolean isDerivedFromUser(String p_strClass)
      Check if the given class is derived from the user class.
      Parameters:
      p_strClass - The class identifier.
      Returns:
      true if the given class is derived from the user class, or false otherwise.

    • isDerivedFromUser

      public static boolean isDerivedFromUser(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
      Check if the given class is derived from the user class.
      Parameters:
      p_class - The class object.
      Returns:
      true if the given class is derived from the user class, or false otherwise.

    • isNoContainer

      public static boolean isNoContainer(int p_iClassID)
      true if p_class is not derived from a container or a set
      Parameters:
      p_iClassID - The class type id
      Returns:
      true if not derived from a container.

    • isNoContainer

      public static boolean isNoContainer(String p_strClass)
      true if p_strClass is not derived from a container or a set
      Parameters:
      p_strClass - The class type name
      Returns:
      true if not derived from a container

    • isNoContainer

      public static boolean isNoContainer(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
      true if p_class is not derived from a container
      Parameters:
      p_class - The class object
      Returns:
      ture if not derived from a container

    • isNoSet

      public static boolean isNoSet(int p_iClassID)
      true if p_class is not derived from a set
      Parameters:
      p_iClassID - The class type id
      Returns:
      true if not derived for a set

    • isNoSet

      public static boolean isNoSet(String p_strClass)
      true if p_strClass is not derived from a set
      Parameters:
      p_strClass - The class type name
      Returns:
      true if class not derived from a set

    • isNoSet

      public static boolean isNoSet(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
      true if p_class is not derived from a set
      Parameters:
      p_class - The class object
      Returns:
      true if not derived from a set

    • isNoContainerOrSet

      public static boolean isNoContainerOrSet(int p_iClassID)
      true if p_iClassID is not derived from a container or a set
      Parameters:
      p_iClassID - The class type id
      Returns:
      true if not derived form a container or set

    • isNoContainerOrSet

      public static boolean isNoContainerOrSet(String p_strClass)
      true if p_strClass is not derived from a container or a set
      Parameters:
      p_strClass - The class type name
      Returns:
      true if not derived from a container or set

    • isNoContainerOrSet

      public static boolean isNoContainerOrSet(de.uplanet.lucy.server.usermanager.ds.DsClass p_class)
      true if p_class is not derived from a container or a set
      Parameters:
      p_class - The class object
      Returns:
      true if not derived from a container or set

    • isArrayAttribute

      public static boolean isArrayAttribute(String p_strGuid)
      checks if the given guid is an array attribute
      Parameters:
      p_strGuid - unique identifier
      Returns:
      true if the attribute of the guid is an array attribute otherwise false

    • mapClassKeyToClassId

      public static int mapClassKeyToClassId(String p_strKey)
      Parameters:
      p_strKey - The class type name (must be valid otherwise an DsRuntime exception will be thrown).
      Returns:
      The class type id.

    • mapClassIdToClassKey

      public static String mapClassIdToClassKey(int p_iID)
      Parameters:
      p_iID - The class type id (must be valid otherwise an DsRuntime exception will be thrown).
      Returns:
      The class type name.

    • isTenantAttributeDefined

      public static boolean isTenantAttributeDefined()
      Is a attribute defined as tenant ID in this schema?
      Returns:
      true if a attribute is defined as tenant ID in this schema.