Package com.im.df.api.ddl
Interface DFDataTree
-
- All Superinterfaces:
DFItem
,DFScriptParent
,PropertiesEditingConfigurable
public interface DFDataTree extends DFScriptParent
Interface representing data tree. Data tree is a basic tree style sub-graph of the whole schema's entity-relationships generic graph. DataTree is oriented graph and doesn't allow to add cycles. DataTree always contains root vertex and zero or more edges going to next vertexes. EachDFDataTree.Vertex
represents oneDFEntity
and eachDFDataTree.Edge
represents someDFRelationship.Direction
. It is possible to look at edges as a relation between master and detail entity (table).
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
DFDataTree.Edge
This object represents an edge in datatree graph.static class
DFDataTree.Path
Defines a path inDFDataTree
.static interface
DFDataTree.Vertex
The Vertex in data tree graph.-
Nested classes/interfaces inherited from interface com.im.df.api.ddl.DFItem
DFItem.Handle<T extends DFItem>
-
Nested classes/interfaces inherited from interface com.im.df.api.support.PropertiesEditingConfigurable
PropertiesEditingConfigurable.Extra
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PROP_QUERIES
static java.lang.String
PROP_VIEWS
-
Fields inherited from interface com.im.df.api.ddl.DFItem
PROP_CAPABILITIES, PROP_DESCRIPTION, PROP_ID, PROP_NAME, PROP_TYPE, PROP_VALID
-
Fields inherited from interface com.im.df.api.ddl.DFScriptParent
PROP_SCRIPTS
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DFResultSet
getDefaultResultSet(boolean showAll, com.im.commons.progress.DFEnvironmentRO env)
Get a default DFResultSet for the given DFDataTree.DFItem.Handle<DFDataTree>
getHandle()
Returns a handle to the Item.DFContainer<DFQuery>
getQueries()
DFDataTree.Vertex
getRootVertex()
DFSchema
getSchema()
Get owner of this datatree.DFContainer<DFView>
getViews()
-
Methods inherited from interface com.im.df.api.ddl.DFItem
addPropertyChangeListener, getCapabilities, getDescription, getId, getName, getType, isValid, removePropertyChangeListener, setDescription, setName
-
Methods inherited from interface com.im.df.api.ddl.DFScriptParent
getScripts
-
Methods inherited from interface com.im.df.api.support.PropertiesEditingConfigurable
isPropertyEditable
-
-
-
-
Field Detail
-
PROP_VIEWS
static final java.lang.String PROP_VIEWS
- See Also:
- Constant Field Values
-
PROP_QUERIES
static final java.lang.String PROP_QUERIES
- See Also:
- Constant Field Values
-
-
Method Detail
-
getRootVertex
DFDataTree.Vertex getRootVertex()
- Returns:
- The root vertex of this DFDataTree. Never return
null
as the root vertex is always defined.
-
getViews
DFContainer<DFView> getViews()
- Returns:
- The container of
DFView
s which are based on this datatree. The Vertex object is immutable, it cannot be changed once it's created. Only new edges can be added.
-
getQueries
DFContainer<DFQuery> getQueries()
- Returns:
- The container of persistent
DFQuery
s.
-
getHandle
DFItem.Handle<DFDataTree> getHandle()
Description copied from interface:DFItem
Returns a handle to the Item. The handle uniquely identifies the Item, even though the schema data may be copied or otherwise replicated. Use the Handle instead of DFItem.getId() when registering an Item in collections that extend beyond the DFItem's parent Schema.
-
getDefaultResultSet
DFResultSet getDefaultResultSet(boolean showAll, com.im.commons.progress.DFEnvironmentRO env)
Get a default DFResultSet for the given DFDataTree. This method just delegates the call toDFSchemaDataProvider.getDefaultResultSet(DFDataTree, boolean, DFEnvironmentRO)
.- Parameters:
showAll
- If the result set is not initialized yet then: loads all rows iftrue
otherwise default result set is returned empty. If result set was already created before then this param is ignoredenv
- The environment- Returns:
- The instance of result set for this datatree
-
getSchema
DFSchema getSchema()
Get owner of this datatree.- Specified by:
getSchema
in interfaceDFScriptParent
- Returns:
- schema which owns this datatree
-
-