Overview  Package   Class  Tree  Index 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

be.lassi.domain
Class FixtureDefinition

java.lang.Object
  extended by be.lassi.base.SaveableObject
      extended by be.lassi.domain.FixtureDefinition

public class FixtureDefinition
extends SaveableObject

Defines a particular type of fixture by describing the fixture attributes and presets.

Constructor Summary
FixtureDefinition()
          Constructs a fixture definition.
FixtureDefinition(Dirty dirty, java.lang.String category, java.lang.String type)
          Constructs a fixture definition.
FixtureDefinition(java.lang.String category, java.lang.String type)
          Constructs a fixture definition.
 
Method Summary
 AttributeDefinition addAttribute(java.lang.String name, java.lang.String channels)
          Adds an attribute definition with given name and channel specification.
 PresetDefinition addPreset(java.lang.String presetName)
          Adds a fixture preset definition with given name.
 boolean equals(java.lang.Object object)
          
 AttributeDefinition getAttribute(int index)
          Gets the fixture attribute at given index.
 AttributeDefinition getAttribute(java.lang.String attributeName)
          Gets the attribute with given name.
 int getAttributeCount()
          Gets the number of attributes in this fixture.
 java.lang.String getCategory()
          Gets the fixture category name.
 PresetDefinition getPreset(int index)
          Gets the fixture preset at given index.
 PresetDefinition getPreset(java.lang.String presetName)
          Gets the preset with given name.
 int getPresetCount()
          Gets the number of presets in this fixture.
 java.lang.String getType()
          Gets the fixture type name.
 int hashCode()
          
 void removeAttribute(int index)
          Removes the fixture attribute at given index.
 void removePreset(int index)
          Removes the fixture preset at given index.
 void setCategory(java.lang.String category)
          Sets the fixture category name.
 void setDirty(Dirty dirty)
          Sets the dirty indicator.
 void setType(java.lang.String type)
          Sets the fixture type name.
 
Methods inherited from class be.lassi.base.SaveableObject
doNotMarkDirty, getDirty, isDirty, markDirty
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FixtureDefinition

public FixtureDefinition()
Constructs a fixture definition.

FixtureDefinition

public FixtureDefinition(Dirty dirty,
                         java.lang.String category,
                         java.lang.String type)
Constructs a fixture definition.

Parameters:
dirty - indicates whether this definition has changed since last save
category - the fixture category
type - the fixture type

FixtureDefinition

public FixtureDefinition(java.lang.String category,
                         java.lang.String type)
Constructs a fixture definition.

Parameters:
category - the fixture category
type - the fixture type
Method Detail

addAttribute

public AttributeDefinition addAttribute(java.lang.String name,
                                        java.lang.String channels)
Adds an attribute definition with given name and channel specification.

Parameters:
name - the attribute name
channels - specification of the attribute channel(s); multiple channels should be comma separated
Returns:
the attribute that was added

addPreset

public PresetDefinition addPreset(java.lang.String presetName)
Adds a fixture preset definition with given name.

Parameters:
presetName - the preset name
Returns:
the preset definition that was added

equals

public boolean equals(java.lang.Object object)

Overrides:
equals in class java.lang.Object

getAttribute

public AttributeDefinition getAttribute(int index)
Gets the fixture attribute at given index.

Parameters:
index - the attribute index
Returns:
the attribute at given index

getAttribute

public AttributeDefinition getAttribute(java.lang.String attributeName)
Gets the attribute with given name.

Parameters:
attributeName - the attribute name
Returns:
the attribute with given name

getAttributeCount

public int getAttributeCount()
Gets the number of attributes in this fixture.

Returns:
the attribute count

getCategory

public java.lang.String getCategory()
Gets the fixture category name.

Returns:
the fixture category name

getPreset

public PresetDefinition getPreset(int index)
Gets the fixture preset at given index.

Parameters:
index - the preset index
Returns:
the preset at given index

getPreset

public PresetDefinition getPreset(java.lang.String presetName)
Gets the preset with given name.

Parameters:
presetName - the preset name
Returns:
the preset with given name

getPresetCount

public int getPresetCount()
Gets the number of presets in this fixture.

Returns:
the preset count

getType

public java.lang.String getType()
Gets the fixture type name.

Returns:
the fixture type name

hashCode

public int hashCode()

Overrides:
hashCode in class java.lang.Object

removeAttribute

public void removeAttribute(int index)
Removes the fixture attribute at given index.

Parameters:
index - the attribute index

removePreset

public void removePreset(int index)
Removes the fixture preset at given index.

Parameters:
index - the preset index

setCategory

public void setCategory(java.lang.String category)
Sets the fixture category name.

Parameters:
category - the fixture category name

setDirty

public void setDirty(Dirty dirty)
Sets the dirty indicator.

Overrides:
setDirty in class SaveableObject
Parameters:
dirty - the dirty indicator

setType

public void setType(java.lang.String type)
Sets the fixture type name.

Parameters:
type - the fixture type name
Overview  Package   Class  Tree  Index 
Lighting Assistant 1.2
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD