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

java.lang.Object
- cb.petal.PetalObject

All Implemented Interfaces:

PetalNode, Serializable, Cloneable

Direct Known Subclasses:

ActionTime, Attribute, Compartment, Defaults, Design, Event, ExternalDoc, FocusOfControl, Font, ItemLabel, Label, Mechanism, Parameter, Petal, QuidObject, SegLabel, SemanticInfo, View
```
public abstract class PetalObject
extends Object
implements PetalNode
```
Super class for all petal objects which have a list of properties. Unfortunately, property names may occur multiply. This can happen, e.g., if there are multiple notes attached to a class. Thus it is not implemented with a HashMap as one might think.

Version:

$Id: PetalObject.java,v 1.29 2005/06/06 11:50:17 moroff Exp $

Author:

M. Dahm

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static ArrayList EMPTY

protected static Logger LOGGER

protected ArrayList params

static boolean strict

Fields
Modifier and Type	Field and Description
`static ArrayList`	`EMPTY`
`protected static Logger`	`LOGGER`
`protected ArrayList`	`params`
`static boolean`	`strict`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PetalObject(PetalNode parent, String name, ArrayList params)`
`protected`	`PetalObject(PetalNode parent, String name, Collection params)`
`protected`	`PetalObject(String name)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`accept(Visitor v)` accept the given visitor
`int`	`addProperty(String name, PetalNode value)` Add a property (which may already exist, Petal files allow to define properties multiply).
`protected void`	`addToList(String prop_name, String list_name, PetalObject o)` Add object to some given list and create the list if necessary.
`Object`	`clone()`
`void`	`defineProperty(String name, boolean value)` Override property if exists already or add it if not.
`void`	`defineProperty(String name, double value)` Override property if exists already or add it if not.
`void`	`defineProperty(String name, int value)` Override property if exists already or add it if not.
`int`	`defineProperty(String name, PetalNode value)` Override property if exists already or add it if not.
`void`	`defineProperty(String name, String value)` Override property if exists already or add it if not.
`boolean`	`equals(Object o)`
`int`	`getChildCount()` get the number of child nodes
`String`	`getKind()` get the kind of this PetalNode
`String`	`getLongestName()`
`String`	`getName()`
`ArrayList<String>`	`getNames()`
`int`	`getNoProperties()`
`ArrayList`	`getParameterList()`
`PetalNode`	`getParent()`
`ArrayList<PetalNode>`	`getProperties(String name)` get the properties with the given name
`PetalNode`	`getProperty(int i)`
`PetalNode`	`getProperty(String name)`
`boolean`	`getPropertyAsBoolean(String name)`
`double`	`getPropertyAsFloat(String name)`
`int`	`getPropertyAsInteger(String name)`
`String`	`getPropertyAsString(String name)`
`ArrayList<PetalNode>`	`getPropertyList()`
`String`	`getPropertyName(PetalNode value)` This method uses the strict indexOf method to find the value.
`Object[][]`	`getPropertyTuples()`
`String`	`getQualifiedName()` Get fully qualified name for an object that must implement the Named interface and is contained by further Named objects.
`PetalFile`	`getRoot()`
`int`	`indexOf(PetalNode value)` This method is strict in that it does not use equals() to search the list of properties but ==, since values, in particular literals may occur more than once.
`void`	`init()` Perform any initial actions after all properties have been set up.
`void`	`moveProperty(int from, int to)` Move property within list of properties, i.e. change order.
`protected void`	`removeFromList(String prop_name, PetalObject o)` Remove object from some given list.
`void`	`removeProperty(int index)` Remove property at given index
`void`	`removeProperty(String name)` Remove property with given name
`void`	`setName(String n)`
`void`	`setParameterList(ArrayList params)`
`void`	`setParent(PetalNode p)`
`void`	`setProperty(int i, String name, PetalNode value)` Override property at i, value's "parent" reference points to this object afterwards
`String`	`toString()`

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

- Field Detail
  - LOGGER
```
protected static Logger LOGGER
```
  - EMPTY
```
public static final ArrayList EMPTY
```
  - params
```
protected ArrayList params
```
  - strict
```
public static boolean strict
```
- Constructor Detail
  - PetalObject
```
protected PetalObject(PetalNode parent,
                      String name,
                      ArrayList params)
```
    Parameters:
    
    parent - node in the petal tree, either another PetalObject or PetalFile
    
    name - of the object, e.g., "ClassCategory"
    
    params - list of parameters, e.g., "Class" "Logical View::templates::Class"
  - PetalObject
```
protected PetalObject(PetalNode parent,
                      String name,
                      Collection params)
```
    Parameters:
    
    parent - node in the petal tree, either another PetalObject or PetalFile
    
    name - of the object, e.g., "ClassCategory"
    
    params - list of parameters, e.g., "Class" "Logical View::templates::Class"
  - PetalObject
```
protected PetalObject(String name)
```
    Parameters:
    
    name - of the object, e.g., "ClassCategory"
- Method Detail
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
    
    Returns:
    
    shallow copy of object, do not forget to assign a new quid if you want to use it within the same model.
  - equals
```
public boolean equals(Object o)
```
    Returns:
    
    true if the name and all properties are equal without regarding the order of the properties.
  - init
```
public void init()
```
    Perform any initial actions after all properties have been set up. Called by PetalParser when all properties have been defined or when a new object created by the user is added to the model.
  - setParent
```
public void setParent(PetalNode p)
```
  - getParent
```
public PetalNode getParent()
```
  - 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
  - setName
```
public void setName(String n)
```
  - getName
```
public String getName()
```
  - getRoot
```
public final PetalFile getRoot()
```
    Returns:
    
    top-level root node of this model
  - setProperty
```
public final void setProperty(int i,
                              String name,
                              PetalNode value)
```
    Override property at i, value's "parent" reference points to this object afterwards
  - addProperty
```
public final int addProperty(String name,
                             PetalNode value)
```
    Add a property (which may already exist, Petal files allow to define properties multiply).
    
    Returns:
    
    index of property
  - indexOf
```
public final int indexOf(PetalNode value)
```
    This method is strict in that it does not use equals() to search the list of properties but ==, since values, in particular literals may occur more than once.
  - getPropertyName
```
public final String getPropertyName(PetalNode value)
```
    This method uses the strict indexOf method to find the value.
  - getNoProperties
```
public int getNoProperties()
```
    Returns:
    
    number of properties
  - getChildCount
```
public int getChildCount()
```
    Description copied from interface: PetalNode
    
    get the number of child nodes
    
    Specified by:
    
    getChildCount in interface PetalNode
    
    Returns:
    
    number of properties
  - defineProperty
```
public final int defineProperty(String name,
                                PetalNode value)
```
    Override property if exists already or add it if not.
    
    Returns:
    
    index of property
  - getProperty
```
public final PetalNode getProperty(int i)
```
    Returns:
    
    property at given index
  - getProperty
```
public final PetalNode getProperty(String name)
```
    Returns:
    
    first occurrence of property name
  - defineProperty
```
public final void defineProperty(String name,
                                 String value)
```
    Override property if exists already or add it if not.
    
    Parameters:
    
    name -
    
    value -
  - getPropertyAsString
```
public String getPropertyAsString(String name)
```
    Returns:
    
    given property, or null if it doesn't exist.
  - getPropertyAsInteger
```
public int getPropertyAsInteger(String name)
```
    Returns:
    
    given property, or Integer.MIN_VALUE if it doesn't exist.
  - defineProperty
```
public void defineProperty(String name,
                           int value)
```
    Override property if exists already or add it if not.
  - getPropertyAsBoolean
```
public boolean getPropertyAsBoolean(String name)
```
    Returns:
    
    given property, or false if it doesn't exist.
  - defineProperty
```
public void defineProperty(String name,
                           boolean value)
```
    Override property if exists already or add it if not.
  - getPropertyAsFloat
```
public double getPropertyAsFloat(String name)
```
    Returns:
    
    given property, or Double.MIN_VALUE if it doesn't exist.
  - defineProperty
```
public void defineProperty(String name,
                           double value)
```
    Override property if exists already or add it if not.
  - removeProperty
```
public void removeProperty(String name)
```
    Remove property with given name
  - removeProperty
```
public void removeProperty(int index)
```
    Remove property at given index
  - moveProperty
```
public void moveProperty(int from,
                         int to)
```
    Move property within list of properties, i.e. change order.
  - getLongestName
```
public String getLongestName()
```
    Returns:
    
    the longest name in names list, needed for indentation issues
  - getProperties
```
public ArrayList<PetalNode> getProperties(String name)
```
    get the properties with the given name
    
    Parameters:
    
    name -
    
    Returns:
    
    all properties with key "name"
  - getNames
```
public ArrayList<String> getNames()
```
    Returns:
    
    all property names
  - getPropertyList
```
public ArrayList<PetalNode> getPropertyList()
```
    Returns:
    
    all property values
  - getPropertyTuples
```
public Object[][] getPropertyTuples()
```
    Returns:
    
    array of properties, where obj[i][0] == name and obj[i][1] == property
  - getParameterList
```
public ArrayList getParameterList()
```
  - setParameterList
```
public void setParameterList(ArrayList params)
```
  - addToList
```
protected void addToList(String prop_name,
                         String list_name,
                         PetalObject o)
```
    Add object to some given list and create the list if necessary.
  - removeFromList
```
protected void removeFromList(String prop_name,
                              PetalObject o)
```
    Remove object from some given list.
  - getQualifiedName
```
public String getQualifiedName()
```
    Get fully qualified name for an object that must implement the Named interface and is contained by further Named objects. Typical nesting of an object is (Design .. (ClassCategory ... (Class ...)))
    
    Returns:
    
    String like "Logical View::University::Professor"
    
    See Also:
    
    Named, Class, UseCase
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - accept
```
public abstract void accept(Visitor v)
```
    Description copied from interface: PetalNode
    
    accept the given visitor
    
    Specified by:
    
    accept in interface PetalNode
    
    Parameters:
    
    v - - the visitor

Class PetalObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

EMPTY

params

strict

Constructor Detail

PetalObject

PetalObject

PetalObject

Method Detail

clone

equals

init

setParent

getParent

getKind

setName

getName

getRoot

setProperty

addProperty

indexOf

getPropertyName

getNoProperties

getChildCount

defineProperty

getProperty

getProperty

defineProperty

getPropertyAsString

getPropertyAsInteger

defineProperty

getPropertyAsBoolean

defineProperty

getPropertyAsFloat

defineProperty

removeProperty

removeProperty

moveProperty

getLongestName

getProperties

getNames

getPropertyList

getPropertyTuples

getParameterList

setParameterList

addToList

removeFromList

getQualifiedName

toString

accept