Package com.simplicite.util

Class Link

  • All Implemented Interfaces:
    java.io.Serializable
    public class Link
extends java.lang.Object
implements java.io.Serializable
    Object link definition
    NB : This object is only dedicated to provide with default and display information on links
    Actual link behavior is handled at object field level (all dynamic business rules,
    except display-related rules, to be applied on links are to be set using object field's link related methods)
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      Link​(ObjectDB parent, java.lang.String id, java.lang.String obj, java.lang.String fld, java.lang.String dbtable, java.lang.String column, java.lang.String objDisplay, java.lang.String fldDisplay, java.lang.String lnkDisplay, java.lang.String lnkPluralDisplay, java.lang.String lnkHelp, java.lang.String card, int order, boolean copy, char associate, boolean visible, boolean inline, char cascad, java.lang.String icon, char render, java.lang.Integer depth)
      Constructor

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static void genAssocActions​(ObjectDB child)
      Build the associate Actions
      java.lang.String getChildField()
      Get optional child foreign key in case of simple N,N
      java.lang.String getChildForeignKey()
      Get optional child column name in case of simple N,N
      java.lang.String getChildObject()
      Get optional child object in case of simple N,N
      java.lang.String getChildTable()
      Get optional child table name in case of simple N,N
      java.lang.String getDataSource()
      Get target table datasource name
      char getDeleteCascade()
      Get cascade delete mode
      java.lang.String getDisplay()
      Get link display label
      java.lang.String getFieldDisplay()
      Get foreign key display label
      java.lang.String getFieldName()
      Get foreign key field name
      java.lang.String getFilter()
      Get contextual search of N,N pillbox
      java.lang.String getForeignKey()
      Get foreign key column name
      java.lang.String getIcon()
      Get link icon
      java.lang.String getId()
      Get link ID
      java.lang.String getLabel()
      Get link display label (alias to getDisplay)
      java.lang.String getLinkDisplay()
      Get link display label
      java.lang.String getLinkHelp()
      Get link help
      int getMaxOccurs()
      Get cardinality max occurs
      int getMinOccurs()
      Get cardinality min occurs
      java.lang.String getName()
      Get link name
      java.lang.String getObjectDisplay()
      Get target object display label
      java.lang.String getObjectName()
      Get target object name
      int getOrder()
      Get link order
      ObjectDB getParent()
      Get parent object
      java.lang.String getPluralDisplay()
      Get link plural display label
      char getRendering()
      Get the link rendering
      java.lang.String getTable()
      Get target table name
      java.lang.Integer getTreeDepth()
      Get the reflexive deep search limit (-1=no limit, null=no search)
      boolean isAssociable()
      Is link with bulk association ?
      boolean isCascadeCopy()
      Is link with cascade copy ?
      boolean isFiltered()
      Is contextual N,N pillbox filtered?
      boolean isInline()
      Deprecated, for removal: This API element is subject to removal in a future version. 
      boolean isInlined()
      Is the referenced form inlined into parent form (case of 0,1 or 1,1 link)
      boolean isReflexive()
      Is link reflexive on same object?
      boolean isVisible()
      Is link visible ?
      void setAssociable​(char a)
      Set bulk association
      void setCascadeCopy​(boolean b)
      Set cascade copy
      void setChildLink​(java.lang.String obj, java.lang.String fk, java.lang.String table, java.lang.String column)
      Set child object in case of simple N,N relationship
      void setDeleteCascade​(char c)
      Set cascade delete mode
      void setDisplay()
      Set link display label
      void setDisplay​(java.lang.String label)
      Set link display label
      void setFilter​(java.lang.String filter)
      Set contextual search of N,N pillbox
      void setInline​(boolean inline)
      Deprecated, for removal: This API element is subject to removal in a future version. 
      void setInlined​(boolean inline)
      Inline referenced form into parent form (case of 0,1 or 1,1 link)
      void setLabel()
      Set link display label (alias to setDisplay)
      void setLabel​(java.lang.String label)
      Set link display label (alias to setDisplay)
      void setLinkDisplay​(java.lang.String disp)
      Set link display label
      void setMaxOccurs​(int max)
      Set cardinality max occurs
      void setMinMax​(java.lang.String card)
      Set cardinality min,max
      void setMinOccurs​(int min)
      Set cardinality min occurs
      void setOrder​(int o)
      Set link order
      void setParent​(ObjectDB o)
      Set parent object
      void setPluralDisplay​(java.lang.String disp)
      Set link plural display label
      void setReflexive​(boolean b)
      Set link as reflexive
      void setRendering​(char r)
      Set link rendering
      void setTreeDepth​(java.lang.Integer depth)
      Set the reflexive link deep search limit
      void setVisible​(boolean vis)
      Set link visible or not
      java.lang.String toString()
      Generates basic string dump for link (useful for debug purposes)

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • RENDER_PILLBOX

        public static final char RENDER_PILLBOX
        Pillbox rendering
        See Also:
        Constant Field Values

      • RENDER_PILLBOX_CREATE

        public static final char RENDER_PILLBOX_CREATE
        Pillbox with creation rendering
        See Also:
        Constant Field Values

    • Constructor Detail

      • Link

        public Link​(ObjectDB parent,
            java.lang.String id,
            java.lang.String obj,
            java.lang.String fld,
            java.lang.String dbtable,
            java.lang.String column,
            java.lang.String objDisplay,
            java.lang.String fldDisplay,
            java.lang.String lnkDisplay,
            java.lang.String lnkPluralDisplay,
            java.lang.String lnkHelp,
            java.lang.String card,
            int order,
            boolean copy,
            char associate,
            boolean visible,
            boolean inline,
            char cascad,
            java.lang.String icon,
            char render,
            java.lang.Integer depth)
        Constructor
        Parameters:
        parent - Parent object
        id - Link id
        obj - Target object name
        fld - Foreign key field name
        dbtable - Target DB table definition (may be in the form datasource;table)
        column - Foreign key DB column
        objDisplay - Object display
        fldDisplay - Field display
        lnkDisplay - Link display (calculated if null)
        lnkPluralDisplay - Optional plural label
        lnkHelp - Optional mini-help
        card - Cardinality min,max examples: 0,n 0,1 2,6
        order - Tab order
        copy - Is cascade copy enabled ?
        associate - Is bulk association enabled ?
        visible - Is visible ?
        inline - Inline inputs in parent form ? (case of 0,1 or 1,1 link)
        cascad - Delete cascade mode
        icon - Object icon
        render - Link rendering
        depth - Reflexive deep search limit (null = none, -1 = deep search)

    • Method Detail

      • getId

        public java.lang.String getId()
        Get link ID
        Returns:
        Link ID

      • getObjectName

        public java.lang.String getObjectName()
        Get target object name
        Returns:
        Target object name

      • getDataSource

        public java.lang.String getDataSource()
        Get target table datasource name
        Returns:
        Target table datasource name

      • getTable

        public java.lang.String getTable()
        Get target table name
        Returns:
        Target table name

      • getObjectDisplay

        public java.lang.String getObjectDisplay()
        Get target object display label
        Returns:
        Target object display label

      • getFieldName

        public java.lang.String getFieldName()
        Get foreign key field name
        Returns:
        Foreign key field name

      • getName

        public java.lang.String getName()
        Get link name
        Returns:
        Link name (<object name><foreign key name>)

      • getForeignKey

        public java.lang.String getForeignKey()
        Get foreign key column name
        Returns:
        Foreign key column name

      • getFieldDisplay

        public java.lang.String getFieldDisplay()
        Get foreign key display label
        Returns:
        Foreign key display label

      • getLinkDisplay

        public java.lang.String getLinkDisplay()
        Get link display label
        Returns:
        Link display label

      • setLinkDisplay

        public void setLinkDisplay​(java.lang.String disp)
        Set link display label
        Parameters:
        disp - Link display label

      • getPluralDisplay

        public java.lang.String getPluralDisplay()
        Get link plural display label
        Returns:
        Link plural display label

      • setPluralDisplay

        public void setPluralDisplay​(java.lang.String disp)
        Set link plural display label
        Parameters:
        disp - Link plural display label

      • getIcon

        public java.lang.String getIcon()
        Get link icon
        Returns:
        Link icon

      • getLinkHelp

        public java.lang.String getLinkHelp()
        Get link help
        Returns:
        Link help

      • getDisplay

        public java.lang.String getDisplay()
        Get link display label
        Returns:
        Link display label

      • getLabel

        public java.lang.String getLabel()
        Get link display label (alias to getDisplay)

      • setDisplay

        public void setDisplay​(java.lang.String label)
        Set link display label
        Parameters:
        label - Explicit label or null

      • setDisplay

        public void setDisplay()
        Set link display label

      • setLabel

        public void setLabel​(java.lang.String label)
        Set link display label (alias to setDisplay)

      • setLabel

        public void setLabel()
        Set link display label (alias to setDisplay)

      • getMinOccurs

        public int getMinOccurs()
        Get cardinality min occurs
        Returns:
        Cardinality min occurs

      • setMinOccurs

        public void setMinOccurs​(int min)
        Set cardinality min occurs
        Parameters:
        min - Cardinality min occurs

      • getMaxOccurs

        public int getMaxOccurs()
        Get cardinality max occurs
        Returns:
        Cardinality max occurs (-1 means infinity)

      • setMaxOccurs

        public void setMaxOccurs​(int max)
        Set cardinality max occurs
        Parameters:
        max - Cardinality max occurs (-1 means infinity)

      • setMinMax

        public void setMinMax​(java.lang.String card)
        Set cardinality min,max
        Parameters:
        card - examples 0,n or 1,2

      • getOrder

        public int getOrder()
        Get link order

      • setOrder

        public void setOrder​(int o)
        Set link order
        Parameters:
        o - Order

      • isCascadeCopy

        public boolean isCascadeCopy()
        Is link with cascade copy ?

      • setCascadeCopy

        public void setCascadeCopy​(boolean b)
        Set cascade copy
        Parameters:
        b - Cascade copy?

      • getDeleteCascade

        public char getDeleteCascade()
        Get cascade delete mode

      • setDeleteCascade

        public void setDeleteCascade​(char c)
        Set cascade delete mode
        Parameters:
        c - Mode

      • isAssociable

        public boolean isAssociable()
        Is link with bulk association ?

      • setAssociable

        public void setAssociable​(char a)
        Set bulk association
        Parameters:
        a - Associate action visibility ACTION_* ?

      • genAssocActions

        public static void genAssocActions​(ObjectDB child)
        Build the associate Actions

      • isVisible

        public boolean isVisible()
        Is link visible ?
        Returns:
        True if visible

      • setVisible

        public void setVisible​(boolean vis)
        Set link visible or not
        Parameters:
        vis - Visible?

      • isInlined

        public boolean isInlined()
        Is the referenced form inlined into parent form (case of 0,1 or 1,1 link)
        Returns:
        True if inlined

      • isInline

        @Deprecated(forRemoval=true,
            since="4.0")
public boolean isInline()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • setInlined

        public void setInlined​(boolean inline)
        Inline referenced form into parent form (case of 0,1 or 1,1 link)
        Parameters:
        inline - Inline child form into parent form?

      • setInline

        @Deprecated(forRemoval=true,
            since="4.0")
public void setInline​(boolean inline)
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getParent

        public ObjectDB getParent()
        Get parent object
        Returns:
        Parent object

      • setParent

        public void setParent​(ObjectDB o)
        Set parent object
        Parameters:
        o - Object

      • getRendering

        public char getRendering()
        Get the link rendering
        Returns:
        Link rendering

      • setRendering

        public void setRendering​(char r)
        Set link rendering
        Parameters:
        r - Link rendering

      • getChildObject

        public java.lang.String getChildObject()
        Get optional child object in case of simple N,N
        Returns:
        Child object

      • getChildField

        public java.lang.String getChildField()
        Get optional child foreign key in case of simple N,N
        Returns:
        Child foreign key

      • getChildTable

        public java.lang.String getChildTable()
        Get optional child table name in case of simple N,N
        Returns:
        Child table

      • getChildForeignKey

        public java.lang.String getChildForeignKey()
        Get optional child column name in case of simple N,N
        Returns:
        Child column

      • setChildLink

        public void setChildLink​(java.lang.String obj,
                         java.lang.String fk,
                         java.lang.String table,
                         java.lang.String column)
        Set child object in case of simple N,N relationship
        Parameters:
        obj - Object
        fk - Foreign key name
        table - Table
        column - Column

      • isReflexive

        public boolean isReflexive()
        Is link reflexive on same object?
        Returns:
        True id link is reflexive

      • setReflexive

        public void setReflexive​(boolean b)
        Set link as reflexive
        Parameters:
        b - Reflexive?

      • getTreeDepth

        public java.lang.Integer getTreeDepth()
        Get the reflexive deep search limit (-1=no limit, null=no search)
        Returns:
        Reflexive deep search limit

      • setTreeDepth

        public void setTreeDepth​(java.lang.Integer depth)
        Set the reflexive link deep search limit
        Parameters:
        depth - Reflexive link deep search limit

      • getFilter

        public java.lang.String getFilter()
        Get contextual search of N,N pillbox
        Returns:
        Contextual search filter

      • setFilter

        public void setFilter​(java.lang.String filter)
        Set contextual search of N,N pillbox
        Parameters:
        filter - Contextual search filter

      • isFiltered

        public boolean isFiltered()
        Is contextual N,N pillbox filtered?
        Returns:
        True if contextual N,N pillbox is filtered

      • toString

        public java.lang.String toString()
        Generates basic string dump for link (useful for debug purposes)
        Overrides:
        toString in class java.lang.Object
        Returns:
        link as string