Package com.wisecoders.dbs.schema

Class Layout

java.lang.Object
com.wisecoders.dbs.diagram.model.AbstractUnit
com.wisecoders.dbs.schema.Layout
All Implemented Interfaces:
AbstractLayout, TreeUnit, Unit, Comparable<AbstractUnit>
public class Layout extends AbstractUnit implements AbstractLayout
Is a diagram plus the Relational Data Browse, SQL editors, Query Builders.

  • Field Details

    • project

      public final Project project

    • diagram

      public final Diagram<Entity> diagram

    • scripts

      public final Folder<Script> scripts

    • layoutDepicts

      public final Folder<LayoutDepict> layoutDepicts

    • browses

      public final Folder<com.wisecoders.dbs.browse.model.Browse> browses

    • queries

      public final Folder<com.wisecoders.dbs.query.model.items.Query> queries

  • Constructor Details

  • Method Details

    • getChildrenCount

      public int getChildrenCount()
      Specified by:
      getChildrenCount in interface TreeUnit
      Overrides:
      getChildrenCount in class AbstractUnit

    • getChildAt

      public TreeUnit getChildAt(int idx)
      Specified by:
      getChildAt in interface TreeUnit
      Overrides:
      getChildAt in class AbstractUnit

    • getEntity

      public AbstractTable getEntity()
      Specified by:
      getEntity in interface Unit

    • getDepicts

      public List<Depict<Entity>> getDepicts()
      Specified by:
      getDepicts in interface AbstractLayout

    • getEntities

      public List<Entity> getEntities()

    • getSymbolicName

      public String getSymbolicName()
      Specified by:
      getSymbolicName in interface Unit
      Specified by:
      getSymbolicName in class AbstractUnit

    • getSymbolicIcon

      public String getSymbolicIcon()
      Specified by:
      getSymbolicIcon in class AbstractUnit

    • getSymbolicGlyph

      public com.wisecoders.dbs.sys.fx.glyph.Glyph getSymbolicGlyph()
      Specified by:
      getSymbolicGlyph in class AbstractUnit

    • getParent

      public TreeUnit getParent()
      Specified by:
      getParent in interface TreeUnit
      Specified by:
      getParent in class AbstractUnit

    • createScript

      public Script createScript(String name)

    • createBrowse

      public com.wisecoders.dbs.browse.model.Browse createBrowse(String name)

    • createQuery

      public com.wisecoders.dbs.query.model.items.Query createQuery(String name)

    • refresh

      public void refresh()
      Calculates new size
      Specified by:
      refresh in class AbstractUnit

    • setConfirmed

      public void setConfirmed(boolean confirmed)

    • isConfirmed

      public boolean isConfirmed()

    • setStoreId

      public void setStoreId(String id)

    • getKey

      public String getKey()
      Overrides:
      getKey in class AbstractUnit
      Returns:
      A string to uniquely identify this Unit. Is used for saving if is open or not, its position, etc.

    • generateHtmlDocumentation

      public void generateHtmlDocumentation(File file) throws IOException
      Generate HTML documentation. Can be called from Groovy code
      Parameters:
      file - to save in
      Throws:
      IOException - on file operation

    • generateHtmlDocumentation

      public void generateHtmlDocumentation(File file, List<Layout> layouts) throws IOException
      Generate HTML documentation. Can be called from Groovy code
      Parameters:
      file - to generate the documentation in
      layouts - diagrams to generate documentation for
      Throws:
      IOException - by problems with the file

    • generateHtmlDocumentation

      public void generateHtmlDocumentation(Expose expose) throws IOException
      Generate HTML documentation. Can be called from Groovy code
      Parameters:
      expose - specifies the content
      Throws:
      IOException - by problems with the file

    • generatePdfDocumentation

      public void generatePdfDocumentation(File file) throws IOException
      Generate PDF documentation. Can be called from Groovy code.
      Parameters:
      file - to save in
      Throws:
      IOException - on file operation

    • generatePdfDocumentation

      public void generatePdfDocumentation(File file, List<Layout> layouts) throws IOException
      Generate PDF documentation. Can be called from Groovy code.
      Parameters:
      file - to generate the documentation in
      layouts - to include in the documentation
      Throws:
      IOException - by problems with the file

    • generatePdfDocumentation

      public void generatePdfDocumentation(Expose expose) throws IOException
      Generate PDF documentation. Can be called from Groovy code.
      Parameters:
      expose - is the specification of the content
      Throws:
      IOException - by problems with the file

    • generateMarkdownDocumentation

      public void generateMarkdownDocumentation(File file, List<Layout> layouts) throws IOException
      Generate Markdown documentation. Can be called from Groovy code.
      Parameters:
      file - to generate the documentation in
      layouts - to include in the documentation
      Throws:
      IOException - by problems with the file

    • generateMarkdownDocumentation

      public void generateMarkdownDocumentation(Expose expose) throws IOException
      Generate Markdown documentation. Can be called from Groovy code.
      Parameters:
      expose - is the specification of the content
      Throws:
      IOException - by problems with the file

    • attach

      public Depict<Entity> attach(Entity entity)

    • attachHierarchical

      public void attachHierarchical(Entity entity)

    • autoArrange

      public void autoArrange()

    • autoArrange

      public void autoArrange(Group group)

    • autoArrangeKeepGroups

      public void autoArrangeKeepGroups()

    • containsDepictForEntity

      public boolean containsDepictForEntity(Entity entity)

    • cloneLayout

      public void cloneLayout(Layout layout, int dx, int dy, boolean copyDiagramProperties)

    • attachManyToManyGeneratedTables

      public void attachManyToManyGeneratedTables()

    • cleanChildEntities

      public void cleanChildEntities()