TemplateThing (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- ini.trakem2.persistence.DBObject
- - ini.trakem2.tree.TemplateThing

All Implemented Interfaces:: Thing, Comparable<TemplateThing>

public final class TemplateThing
extends DBObject
implements Thing, Comparable<TemplateThing>

Field Summary
- Fields inherited from class ini.trakem2.persistence.DBObject
  id, project

Constructor Summary

Constructors
Constructor and Description
`TemplateThing(String type)` Create a new non-database-stored TemplateThing.
`TemplateThing(String type, Project project)` Create a new database-stored TemplateThing.
`TemplateThing(String type, Project project, long id)` Reconstruct a TemplateThing from the database.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addChild(Thing child)`
`void`	`addToDatabase(Project project)` Recursive into children! Will add the attributes as well and grab an id for this instance.
`boolean`	`canHaveAsChild(Thing thing)`
`TemplateThing`	`clone(Project pr, boolean copy_id)` Recursive into children: clones the whole tree from this node downward.
`ArrayList<TemplateThing>`	`collectAllChildren(ArrayList<TemplateThing> al)` Recursive into children.
`HashSet<TemplateThing>`	`collectSimilarThings(TemplateThing tt, HashSet<TemplateThing> hs)` Recursive into children, find those of the given type that have the same immediate parent type as the given TemplateThing.
`HashSet<TemplateThing>`	`collectSimilarThings2(TemplateThing tt, HashSet<TemplateThing> hs)` Recursive into children, find those of the same type as the given TemplateThing and whose number of children is the same to those of the given TemplateThing (to exclude nested types).
`HashSet<TemplateThing>`	`collectThingsOfEqualType(TemplateThing tt, HashSet<TemplateThing> hs)` Find things of the same type, even if their parents are different, recusively into children.
`int`	`compareTo(TemplateThing o)` Compares the String type, for sorting purposes.
`void`	`debug(String indent)`
`void`	`exportDTD(StringBuilder sb_header, HashSet<String> hs, String indent)` Only the header !ELEMENT and !ATTLIST.
`void`	`exportXMLTemplate(StringBuffer sb_header, StringBuffer sb_body, HashSet<String> hs, String indent)`
`Thing`	`findChild(Object ob)` Ah, we love interfaces don't we.
`ArrayList<TemplateThing>`	`getChildren()`
`TemplateThing`	`getChildTemplate(String type)`
`String`	`getInfo()` Return information on this node and its object.
`Object`	`getObject()` Returns null always, for TemplateThings don't hold any real object.
`Thing`	`getParent()`
`protected ArrayList<TemplateThing>`	`getTemplatePathTo(String type, ArrayList<TemplateThing> al)` Returns the list of parents to reach a particular child, starting at this, and including the child.
`String`	`getType()`
`HashMap<String,TemplateThing>`	`getUniqueTypes(HashMap<String,TemplateThing> ht)` Recursive into children.
`String`	`getValue()`
`boolean`	`hasChildren()`
`boolean`	`isExpanded()`
`boolean`	`isNested()` Determine whether this instance is nested inside the tree of an instance of the same type (for example, a neurite_branch inside another neurite_branch)
`boolean`	`remove(boolean check)` Subclasses can override this method to perform other tasks before removing itself from the database.
`boolean`	`removeChild(TemplateThing child)`
`protected void`	`rename(String new_name)` Change the type to new_name.
`void`	`setParent(Thing parent)`
`void`	`setup(ArrayList<TemplateThing> al_children)` For reconstruction purposes.
`void`	`setValue(String value)`
`Thing`	`shallowCopy()` A new copy with same type, same project, same id, but no parent and no children.
`String`	`toString()`
`boolean`	`uniquePathExists(String type)` Check if a unique path exists through the child trees until reaching a Thing of the given type.

Methods inherited from class ini.trakem2.persistence.DBObject
addToDatabase, exportXML, getId, getProject, getShortTitle, getTitle, getUniqueIdentifier, removeFromDatabase, updateInDatabase, updateInDatabase

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ini.trakem2.tree.Thing
getTitle

- Constructor Detail
  - TemplateThing
```
public TemplateThing(String type)
```
    Create a new non-database-stored TemplateThing.
  - TemplateThing
```
public TemplateThing(String type,
                     Project project)
```
    Create a new database-stored TemplateThing.
  - TemplateThing
```
public TemplateThing(String type,
                     Project project,
                     long id)
```
    Reconstruct a TemplateThing from the database.
- Method Detail
  - shallowCopy
```
public Thing shallowCopy()
```
    A new copy with same type, same project, same id, but no parent and no children.
    
    Specified by:
    
    shallowCopy in interface Thing
  - setup
```
public void setup(ArrayList<TemplateThing> al_children)
```
    For reconstruction purposes.
  - addToDatabase
```
public void addToDatabase(Project project)
```
    Recursive into children! Will add the attributes as well and grab an id for this instance.
  - setValue
```
public void setValue(String value)
```
  - getValue
```
public String getValue()
```
  - setParent
```
public void setParent(Thing parent)
```
    Specified by:
    
    setParent in interface Thing
  - getParent
```
public Thing getParent()
```
    Specified by:
    
    getParent in interface Thing
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface Thing
    
    Overrides:
    
    toString in class Object
  - getType
```
public String getType()
```
    Specified by:
    
    getType in interface Thing
  - getChildTemplate
```
public TemplateThing getChildTemplate(String type)
```
  - addChild
```
public boolean addChild(Thing child)
```
    Specified by:
    
    addChild in interface Thing
  - getChildren
```
public ArrayList<TemplateThing> getChildren()
```
    Specified by:
    
    getChildren in interface Thing
  - hasChildren
```
public boolean hasChildren()
```
    Specified by:
    
    hasChildren in interface Thing
  - canHaveAsChild
```
public boolean canHaveAsChild(Thing thing)
```
    Specified by:
    
    canHaveAsChild in interface Thing
  - uniquePathExists
```
public boolean uniquePathExists(String type)
```
    Check if a unique path exists through the child trees until reaching a Thing of the given type. Does not look inside that found thing if any.
  - getTemplatePathTo
```
protected ArrayList<TemplateThing> getTemplatePathTo(String type,
                                                     ArrayList<TemplateThing> al)
```
    Returns the list of parents to reach a particular child, starting at this, and including the child. Only the first path is reported, others are ignored.
  - getObject
```
public Object getObject()
```
    Returns null always, for TemplateThings don't hold any real object.
    
    Specified by:
    
    getObject in interface Thing
  - findChild
```
public Thing findChild(Object ob)
```
    Ah, we love interfaces don't we. This method returns null.
    
    Specified by:
    
    findChild in interface Thing
  - getUniqueTypes
```
public HashMap<String,TemplateThing> getUniqueTypes(HashMap<String,TemplateThing> ht)
```
    Recursive into children. The parent of each stored TemplateThing are not meaningful for a tree; only the children are meaningful.
  - collectAllChildren
```
public ArrayList<TemplateThing> collectAllChildren(ArrayList<TemplateThing> al)
```
    Recursive into children.
  - rename
```
protected void rename(String new_name)
```
    Change the type to new_name.
  - remove
```
public boolean remove(boolean check)
```
    Description copied from class: DBObject
    
    Subclasses can override this method to perform other tasks before removing itself from the database.
    
    Overrides:
    
    remove in class DBObject
  - removeChild
```
public boolean removeChild(TemplateThing child)
```
  - collectSimilarThings
```
public HashSet<TemplateThing> collectSimilarThings(TemplateThing tt,
                                                   HashSet<TemplateThing> hs)
```
    Recursive into children, find those of the given type that have the same immediate parent type as the given TemplateThing.
  - collectSimilarThings2
```
public HashSet<TemplateThing> collectSimilarThings2(TemplateThing tt,
                                                    HashSet<TemplateThing> hs)
```
    Recursive into children, find those of the same type as the given TemplateThing and whose number of children is the same to those of the given TemplateThing (to exclude nested types).
  - collectThingsOfEqualType
```
public HashSet<TemplateThing> collectThingsOfEqualType(TemplateThing tt,
                                                       HashSet<TemplateThing> hs)
```
    Find things of the same type, even if their parents are different, recusively into children.
  - isNested
```
public boolean isNested()
```
    Determine whether this instance is nested inside the tree of an instance of the same type (for example, a neurite_branch inside another neurite_branch)
  - exportDTD
```
public void exportDTD(StringBuilder sb_header,
                      HashSet<String> hs,
                      String indent)
```
    Only the header !ELEMENT and !ATTLIST.
  - exportXMLTemplate
```
public void exportXMLTemplate(StringBuffer sb_header,
                              StringBuffer sb_body,
                              HashSet<String> hs,
                              String indent)
```
  - debug
```
public void debug(String indent)
```
    Specified by:
    
    debug in interface Thing
  - isExpanded
```
public boolean isExpanded()
```
    Specified by:
    
    isExpanded in interface Thing
  - getInfo
```
public String getInfo()
```
    Return information on this node and its object.
    
    Specified by:
    
    getInfo in interface Thing
    
    Overrides:
    
    getInfo in class DBObject
  - clone
```
public TemplateThing clone(Project pr,
                           boolean copy_id)
```
    Recursive into children: clones the whole tree from this node downward.
  - compareTo
```
public int compareTo(TemplateThing o)
```
    Compares the String type, for sorting purposes.
    
    Specified by:
    
    compareTo in interface Comparable<TemplateThing>

Class TemplateThing

Field Summary

Fields inherited from class ini.trakem2.persistence.DBObject

Constructor Summary

Method Summary

Methods inherited from class ini.trakem2.persistence.DBObject

Methods inherited from class java.lang.Object

Methods inherited from interface ini.trakem2.tree.Thing

Constructor Detail

TemplateThing

TemplateThing

TemplateThing

Method Detail

shallowCopy

setup

addToDatabase

setValue

getValue

setParent

getParent

toString

getType

getChildTemplate

addChild

getChildren

hasChildren

canHaveAsChild

uniquePathExists

getTemplatePathTo

getObject

findChild

getUniqueTypes

collectAllChildren

rename

remove

removeChild

collectSimilarThings

collectSimilarThings2

collectThingsOfEqualType

isNested

exportDTD

exportXMLTemplate

debug

isExpanded

getInfo

clone

compareTo