PetalFile (BITPlan crazybeans fork of http://crazybeans.sourceforge.net/ 1.5.1 1.5.5 API)

java.lang.Object
- cb.petal.PetalFile

All Implemented Interfaces:

PetalNode, Serializable, Cloneable, TreeModel
```
public class PetalFile
extends Object
implements PetalNode, TreeModel
```
Top level node (aka. model) containing two children: Petal and Design. To be used in GUI applications it also may be used as the tree model for a JTree.

Version:

$Id: PetalFile.java,v 1.15 2001/11/01 15:56:49 dahm Exp $

Author:

M. Dahm

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PetalFile()

PetalFile(Petal petal, Design design)

Constructors
Constructor and Description
`PetalFile()`
`PetalFile(Petal petal, Design design)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(Visitor v)` accept the given visitor
`void`	`addTreeModelListener(TreeModelListener l)` Adds a listener for the TreeModelEvent posted after the tree changes.
`Object`	`clone()`
`boolean`	`equals(Object o)`
`List`	`getAssociations(Class clazz)` If the association has registered itself properly (done in Association.init() by default) one can look up what associations a class has.
`Object`	`getChild(Object node, int index)` Returns the child of parent at index index in the parent's child array.
`int`	`getChildCount()` get the number of child nodes
`int`	`getChildCount(Object node)` Returns the number of children of parent.
`Class`	`getClassByQualifiedName(String qual)`
`Class`	`getClassByQuid(String quid)`
`Class`	`getClassByQuidu(HasQuidu obj)`
`Design`	`getDesign()`
`int`	`getIndexOfChild(Object node, Object child)`
`String`	`getKind()` get the kind of this PetalNode
`LogicalCategory`	`getLogicalCategory()`
`String`	`getModelName()`
`int`	`getNewTag()` Tags are numbered consecutively within a model file.
`Petal`	`getPetal()`
`static String`	`getQuid()`
`QuidObject`	`getQuidObject(String quid)`
`QuidObject`	`getReferencedObject(HasQuidu obj)`
`Object`	`getRoot()`
`UseCaseCategory`	`getUseCaseCategory()`
`boolean`	`isLeaf(Object node)`
`void`	`registerAssociation(Association a)` Register the association internally, i.e. associate it with the given classes.
`void`	`registerClass(Class clazz)` Register class by its fully qualified name
`void`	`registerQuidObject(QuidObject obj)` Register class by its "quid" property.
`void`	`registerQuidObject(String quid, QuidObject obj)` Register class by its quid property.
`void`	`removeTreeModelListener(TreeModelListener l)` Removes a listener previously added with addTreeModelListener().
`void`	`setDesign(Design p)`
`void`	`setModelName(String v)`
`void`	`setPetal(Petal p)`
`String`	`toString()`
`void`	`valueForPathChanged(TreePath path, Object newValue)` Messaged when the user has altered the value for the item identified by path to newValue.

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

- Constructor Detail
  - PetalFile
```
public PetalFile(Petal petal,
                 Design design)
```
  - PetalFile
```
public PetalFile()
```
- Method Detail
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - setPetal
```
public void setPetal(Petal p)
```
  - getPetal
```
public Petal getPetal()
```
  - setDesign
```
public void setDesign(Design p)
```
  - getDesign
```
public Design getDesign()
```
  - getModelName
```
public String getModelName()
```
  - setModelName
```
public void setModelName(String v)
```
  - accept
```
public void accept(Visitor v)
```
    Description copied from interface: PetalNode
    
    accept the given visitor
    
    Specified by:
    
    accept in interface PetalNode
    
    Parameters:
    
    v - - the visitor
  - getKind
```
public String getKind()
```
    Description copied from interface: PetalNode
    
    get the kind of this PetalNode
    
    Specified by:
    
    getKind in interface PetalNode
    
    Returns:
    
    - the PetaNode kind
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getQuid
```
public static String getQuid()
```
    Returns:
    
    unique quid - as with Rational Rose this is simply the current time expressed as the number of seconds elapsed since January 1, 1970 + some random number. If the resulting string is shorter than 12 characters it is filled up with some random characters.
  - registerQuidObject
```
public final void registerQuidObject(String quid,
                                     QuidObject obj)
```
    Register class by its quid property.
  - registerQuidObject
```
public final void registerQuidObject(QuidObject obj)
```
    Register class by its "quid" property.
  - getQuidObject
```
public final QuidObject getQuidObject(String quid)
```
    Returns:
    
    object by its "quid" (if registered via init())
  - getClassByQuid
```
public final Class getClassByQuid(String quid)
```
    Returns:
    
    class object by its "quid" property (if registered via init())
  - getClassByQuidu
```
public final Class getClassByQuidu(HasQuidu obj)
```
    Returns:
    
    class object by the quidu reference, i.e. a HasQuidu contains a reference to a class denoted by the "quidu" property
  - getReferencedObject
```
public final QuidObject getReferencedObject(HasQuidu obj)
```
  - registerClass
```
public final void registerClass(Class clazz)
```
    Register class by its fully qualified name
  - getClassByQualifiedName
```
public final Class getClassByQualifiedName(String qual)
```
    Returns:
    
    class by its fully qualified name
  - registerAssociation
```
public final void registerAssociation(Association a)
```
    Register the association internally, i.e. associate it with the given classes. So the classes can look up the associations related to them.
  - getAssociations
```
public final List getAssociations(Class clazz)
```
    If the association has registered itself properly (done in Association.init() by default) one can look up what associations a class has.
  - getLogicalCategory
```
public LogicalCategory getLogicalCategory()
```
    Returns:
    
    top level LogicalCategory
  - getUseCaseCategory
```
public UseCaseCategory getUseCaseCategory()
```
    Returns:
    
    top level UseCaseCategory
  - getNewTag
```
public final int getNewTag()
```
    Tags are numbered consecutively within a model file. So we just use in internal counter.
  - getRoot
```
public Object getRoot()
```
    Specified by:
    
    getRoot in interface TreeModel
    
    Returns:
    
    the root of the tree which is just "this" object.
  - addTreeModelListener
```
public void addTreeModelListener(TreeModelListener l)
```
    Adds a listener for the TreeModelEvent posted after the tree changes.
    
    Specified by:
    
    addTreeModelListener in interface TreeModel
  - removeTreeModelListener
```
public void removeTreeModelListener(TreeModelListener l)
```
    Removes a listener previously added with addTreeModelListener().
    
    Specified by:
    
    removeTreeModelListener in interface TreeModel
  - isLeaf
```
public boolean isLeaf(Object node)
```
    Specified by:
    
    isLeaf in interface TreeModel
    
    Returns:
    
    true if (petal) node is a leaf.
  - getChildCount
```
public int getChildCount(Object node)
```
    Returns the number of children of parent.
    
    Specified by:
    
    getChildCount in interface TreeModel
  - getChild
```
public Object getChild(Object node,
                       int index)
```
    Returns the child of parent at index index in the parent's child array.
    
    Specified by:
    
    getChild in interface TreeModel
  - getIndexOfChild
```
public int getIndexOfChild(Object node,
                           Object child)
```
    Specified by:
    
    getIndexOfChild in interface TreeModel
  - getChildCount
```
public int getChildCount()
```
    Description copied from interface: PetalNode
    
    get the number of child nodes
    
    Specified by:
    
    getChildCount in interface PetalNode
    
    Returns:
    
    the number of child nodes
  - valueForPathChanged
```
public void valueForPathChanged(TreePath path,
                                Object newValue)
```
    Messaged when the user has altered the value for the item identified by path to newValue. TODO
    
    Specified by:
    
    valueForPathChanged in interface TreeModel

Class PetalFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PetalFile

PetalFile

Method Detail

equals

clone

setPetal

getPetal

setDesign

getDesign

getModelName

setModelName

accept

getKind

toString

getQuid

registerQuidObject

registerQuidObject

getQuidObject

getClassByQuid

getClassByQuidu

getReferencedObject

registerClass

getClassByQualifiedName

registerAssociation

getAssociations

getLogicalCategory

getUseCaseCategory

getNewTag

getRoot

addTreeModelListener

removeTreeModelListener

isLeaf

getChildCount

getChild

getIndexOfChild

getChildCount

valueForPathChanged