ComponentDMW (dark-matter-mvw 2.1.2 API)

java.lang.Object
- org.dmd.dmc.DmcContainer
- - org.dmd.dmw.DmwWrapper
  - - org.dmd.dmw.DmwNamedObjectWrapper
    - - org.dmd.mvw.tools.mvwgenerator.generated.dmw.MvwDefinitionDMW
      - org.dmd.mvw.tools.mvwgenerator.extended.MvwDefinition
        
        org.dmd.mvw.tools.mvwgenerator.generated.dmw.ComponentDMW

All Implemented Interfaces:

org.dmd.dmc.DmcContainerIF, org.dmd.dmc.DmcNamedObjectIF

Direct Known Subclasses:

Component
```
public abstract class ComponentDMW
extends MvwDefinition
implements org.dmd.dmc.DmcNamedObjectIF
```
The Component is an abstract base for classes that define the building blocks\n of Applications. The primary feature of an Component is that it fires and/or handles events.\n Beyond that, a component can be whatever you require it to be. A variety of derived component types\n provide more focussed behavioural units.\n
\n Many of the classes generated by MVW must be extended in order to provide the actual\n behaviour of your application e.g. Controllers, Views, Presenters etc. Activities must\n also be extended to provide your behaviour, however, Activities are also referred to\n by generated code and must be in a known location. By default, the classes that extend\n the generated activity class will reside in the 'extended' package that lies beneath the\n genPackage specified for your module i.e. if your gen package is com.mine, then the \n derived activity classes are expected to be in com.mine.extended. If you want to place\n these classes in a subpackage beneath extended, use the subpackage attribute to indicate\n the package name e.g. if subpackage is defined as 'activities', your activity implementation\n class will be expected to reside in com.mine.extended.activities.
Generated from the mvw schema at version 0.1
This code was auto-generated by the dmggenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dmg.generators.BaseDMWGenerator.dumpWrapper(BaseDMWGenerator.java:488)

Field Summary
- Fields inherited from class org.dmd.dmc.DmcContainer
  core

Constructor Summary

Constructors
Modifier Constructor and Description

protected ComponentDMW()

protected ComponentDMW(ComponentDMO obj, org.dmd.dms.ClassDefinition cd)

Constructors
Modifier	Constructor and Description
`protected`	`ComponentDMW()`
`protected`	`ComponentDMW(ComponentDMO obj, org.dmd.dms.ClassDefinition cd)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`org.dmd.dmc.DmcAttribute<?>`	`addFiresEvent(Event value)` Adds another firesEvent value.
`org.dmd.dmc.DmcAttribute<?>`	`addHandlesEvent(Event value)` Adds another handlesEvent value.
`org.dmd.dmc.DmcAttribute<?>`	`addInstantiatesView(View value)` Adds another instantiatesView value.
`void`	`addSendsRequest(Object value)` Adds another sendsRequest value.
`void`	`addSendsRequest(RequestTypeWithOptions value)` Adds another sendsRequest value.
`org.dmd.dmc.DmcAttribute<?>`	`addUseSchema(org.dmd.dms.SchemaDefinition value)` Adds another useSchema value.
`org.dmd.dmc.DmcAttribute<?>`	`addUsesRunContextItem(RunContextItem value)` Adds another usesRunContextItem value.
`void`	`delFiresEvent(Event value)` Deletes a firesEvent value.
`void`	`delHandlesEvent(Event value)` Deletes a handlesEvent value.
`void`	`delInstantiatesView(View value)` Deletes a instantiatesView value.
`void`	`delSendsRequest(Object value)` Deletes a sendsRequest value.
`void`	`delSendsRequest(RequestTypeWithOptions value)` Deletes a sendsRequest value.
`void`	`delUseSchema(org.dmd.dms.SchemaDefinition value)` Deletes a useSchema value.
`void`	`delUsesRunContextItem(RunContextItem value)` Deletes a usesRunContextItem value.
`boolean`	`equals(Object obj)`
`org.dmd.dmc.types.CamelCaseName`	`getComponentName()`
`ComponentDMO`	`getDMO()`
`Event`	`getFiresEvent(Object key)`
`TreeMap<org.dmd.dmc.types.CamelCaseName,Event>`	`getFiresEventCopy()`
`org.dmd.dmc.types.CamelCaseName`	`getFiresEventFirstKey()`
`boolean`	`getFiresEventHasValue()`
`boolean`	`getFiresEventIsEmpty()`
`EventIterableDMW`	`getFiresEventIterable()`
`int`	`getFiresEventSize()`
`Event`	`getHandlesEvent(Object key)`
`TreeMap<org.dmd.dmc.types.CamelCaseName,Event>`	`getHandlesEventCopy()`
`org.dmd.dmc.types.CamelCaseName`	`getHandlesEventFirstKey()`
`boolean`	`getHandlesEventHasValue()`
`boolean`	`getHandlesEventIsEmpty()`
`EventIterableDMW`	`getHandlesEventIterable()`
`int`	`getHandlesEventSize()`
`ArrayList<View>`	`getInstantiatesViewCopy()`
`boolean`	`getInstantiatesViewHasValue()`
`boolean`	`getInstantiatesViewIsEmpty()`
`ViewIterableDMW`	`getInstantiatesViewIterable()`
`int`	`getInstantiatesViewSize()`
`abstract Component`	`getModificationRecorder()`
`org.dmd.dmc.types.CamelCaseName`	`getObjectName()`
`org.dmd.dmc.DmcAttribute<?>`	`getObjectNameAttribute()`
`ArrayList<RequestTypeWithOptions>`	`getSendsRequestCopy()`
`boolean`	`getSendsRequestHasValue()`
`boolean`	`getSendsRequestIsEmpty()`
`RequestTypeWithOptionsIterableDMW`	`getSendsRequestIterable()`
`int`	`getSendsRequestSize()`
`String`	`getSubpackage()`
`String`	`getUseBaseClass()`
`ArrayList<org.dmd.dms.SchemaDefinition>`	`getUseSchemaCopy()`
`boolean`	`getUseSchemaHasValue()`
`boolean`	`getUseSchemaIsEmpty()`
`org.dmd.dms.generated.dmw.SchemaDefinitionIterableDMW`	`getUseSchemaIterable()`
`int`	`getUseSchemaSize()`
`TreeSet<RunContextItem>`	`getUsesRunContextItemCopy()`
`boolean`	`getUsesRunContextItemHasValue()`
`boolean`	`getUsesRunContextItemIsEmpty()`
`RunContextItemIterableDMW`	`getUsesRunContextItemIterable()`
`int`	`getUsesRunContextItemSize()`
`int`	`hashCode()`
`void`	`remComponentName()` Removes the componentName attribute value.
`void`	`remFiresEvent()` Removes the firesEvent attribute value.
`void`	`remHandlesEvent()` Removes the handlesEvent attribute value.
`void`	`remInstantiatesView()` Removes the instantiatesView attribute value.
`void`	`remSendsRequest()` Removes the sendsRequest attribute value.
`void`	`remSubpackage()` Removes the subpackage attribute value.
`void`	`remUseBaseClass()` Removes the useBaseClass attribute value.
`void`	`remUseSchema()` Removes the useSchema attribute value.
`void`	`remUsesRunContextItem()` Removes the usesRunContextItem attribute value.
`boolean`	`sendsRequestContains(RequestTypeWithOptions value)` Returns true if the collection contains the sendsRequest value.
`void`	`setComponentName(org.dmd.dmc.types.CamelCaseName value)` Sets componentName to the specified value.
`void`	`setComponentName(Object value)` Sets componentName to the specified value.
`void`	`setSubpackage(Object value)` Sets subpackage to the specified value.
`void`	`setSubpackage(String value)` Sets subpackage to the specified value.
`void`	`setUseBaseClass(Object value)` Sets useBaseClass to the specified value.
`void`	`setUseBaseClass(String value)` Sets useBaseClass to the specified value.

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.extended.MvwDefinition
resolveReferences

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.generated.dmw.MvwDefinitionDMW
addDescription, addDescription, delDescription, delDescription, descriptionContains, getCamelCaseName, getDefinedInModule, getDescriptionCopy, getDescriptionHasValue, getDescriptionIsEmpty, getDescriptionIterable, getDescriptionSize, getFile, getLineNumber, remCamelCaseName, remDefinedInModule, remDescription, remFile, remLineNumber, setCamelCaseName, setCamelCaseName, setDefinedInModule, setDefinedInModule, setFile, setFile, setLineNumber, setLineNumber

Methods inherited from class org.dmd.dmw.DmwWrapper
addAux, applyModifier, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, setDmcObject, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer
getDeleted, getModifier, setDeleted, setModifier

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

- Constructor Detail
  - ComponentDMW
```
protected ComponentDMW()
```
  - ComponentDMW
```
protected ComponentDMW(ComponentDMO obj,
                       org.dmd.dms.ClassDefinition cd)
```
- Method Detail
  - getModificationRecorder
```
public abstract Component getModificationRecorder()
```
    Specified by:
    
    getModificationRecorder in class MvwDefinitionDMW
  - getDMO
```
public ComponentDMO getDMO()
```
    Overrides:
    
    getDMO in class MvwDefinitionDMW
  - getObjectName
```
public org.dmd.dmc.types.CamelCaseName getObjectName()
```
    Specified by:
    
    getObjectName in interface org.dmd.dmc.DmcNamedObjectIF
    
    Overrides:
    
    getObjectName in class MvwDefinitionDMW
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class MvwDefinitionDMW
  - getObjectNameAttribute
```
public org.dmd.dmc.DmcAttribute<?> getObjectNameAttribute()
```
    Specified by:
    
    getObjectNameAttribute in interface org.dmd.dmc.DmcNamedObjectIF
    
    Overrides:
    
    getObjectNameAttribute in class MvwDefinitionDMW
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface org.dmd.dmc.DmcNamedObjectIF
    
    Overrides:
    
    equals in class MvwDefinitionDMW
  - getComponentName
```
public org.dmd.dmc.types.CamelCaseName getComponentName()
```
  - setComponentName
```
public void setComponentName(Object value)
                      throws org.dmd.dmc.DmcValueException
```
    Sets componentName to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeCamelCaseName
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - setComponentName
```
public void setComponentName(org.dmd.dmc.types.CamelCaseName value)
```
    Sets componentName to the specified value.
    
    Parameters:
    
    value - CamelCaseName
  - remComponentName
```
public void remComponentName()
```
    Removes the componentName attribute value.
  - getFiresEventSize
```
public int getFiresEventSize()
```
    Returns:
    
    The number of EventDMO items.
  - getFiresEventIsEmpty
```
public boolean getFiresEventIsEmpty()
```
    Returns:
    
    true if there are no EventDMO items.
  - getFiresEventHasValue
```
public boolean getFiresEventHasValue()
```
    Returns:
    
    true if there are any EventDMO items.
  - getFiresEvent
```
public Event getFiresEvent(Object key)
```
    Returns:
    
    The keyed Event object if it's available and null otherwise.
  - getFiresEventFirstKey
```
public org.dmd.dmc.types.CamelCaseName getFiresEventFirstKey()
```
    Returns:
    
    the first key of the map.
  - getFiresEventIterable
```
public EventIterableDMW getFiresEventIterable()
```
    Returns:
    
    An Iterable of Event objects.
  - addFiresEvent
```
public org.dmd.dmc.DmcAttribute<?> addFiresEvent(Event value)
```
    Adds another firesEvent value.
    
    Parameters:
    
    value - EventDMW
  - delFiresEvent
```
public void delFiresEvent(Event value)
```
    Deletes a firesEvent value.
    
    Parameters:
    
    value - The Event to be deleted from set of attribute values.
  - getFiresEventCopy
```
public TreeMap<org.dmd.dmc.types.CamelCaseName,Event> getFiresEventCopy()
```
    Returns:
    
    A COPY of the collection of Event objects.
  - remFiresEvent
```
public void remFiresEvent()
```
    Removes the firesEvent attribute value.
  - getHandlesEventSize
```
public int getHandlesEventSize()
```
    Returns:
    
    The number of EventDMO items.
  - getHandlesEventIsEmpty
```
public boolean getHandlesEventIsEmpty()
```
    Returns:
    
    true if there are no EventDMO items.
  - getHandlesEventHasValue
```
public boolean getHandlesEventHasValue()
```
    Returns:
    
    true if there are any EventDMO items.
  - getHandlesEvent
```
public Event getHandlesEvent(Object key)
```
    Returns:
    
    The keyed Event object if it's available and null otherwise.
  - getHandlesEventFirstKey
```
public org.dmd.dmc.types.CamelCaseName getHandlesEventFirstKey()
```
    Returns:
    
    the first key of the map.
  - getHandlesEventIterable
```
public EventIterableDMW getHandlesEventIterable()
```
    Returns:
    
    An Iterable of Event objects.
  - addHandlesEvent
```
public org.dmd.dmc.DmcAttribute<?> addHandlesEvent(Event value)
```
    Adds another handlesEvent value.
    
    Parameters:
    
    value - EventDMW
  - delHandlesEvent
```
public void delHandlesEvent(Event value)
```
    Deletes a handlesEvent value.
    
    Parameters:
    
    value - The Event to be deleted from set of attribute values.
  - getHandlesEventCopy
```
public TreeMap<org.dmd.dmc.types.CamelCaseName,Event> getHandlesEventCopy()
```
    Returns:
    
    A COPY of the collection of Event objects.
  - remHandlesEvent
```
public void remHandlesEvent()
```
    Removes the handlesEvent attribute value.
  - getInstantiatesViewSize
```
public int getInstantiatesViewSize()
```
    Returns:
    
    The number of View items.
  - getInstantiatesViewIsEmpty
```
public boolean getInstantiatesViewIsEmpty()
```
    Returns:
    
    true if there are no ViewDMO items.
  - getInstantiatesViewHasValue
```
public boolean getInstantiatesViewHasValue()
```
    Returns:
    
    true if there are any ViewDMO items.
  - getInstantiatesViewIterable
```
public ViewIterableDMW getInstantiatesViewIterable()
```
    Returns:
    
    An Iterator of ViewDMO objects.
  - addInstantiatesView
```
public org.dmd.dmc.DmcAttribute<?> addInstantiatesView(View value)
```
    Adds another instantiatesView value.
    
    Parameters:
    
    value - A value compatible with View
  - delInstantiatesView
```
public void delInstantiatesView(View value)
```
    Deletes a instantiatesView value.
    
    Parameters:
    
    value - The View to be deleted from set of attribute values.
  - getInstantiatesViewCopy
```
public ArrayList<View> getInstantiatesViewCopy()
```
    Returns:
    
    A COPY of the collection of View objects.
  - remInstantiatesView
```
public void remInstantiatesView()
```
    Removes the instantiatesView attribute value.
  - getSendsRequestSize
```
public int getSendsRequestSize()
```
    Returns:
    
    The number of RequestTypeWithOptions items.
  - getSendsRequestIsEmpty
```
public boolean getSendsRequestIsEmpty()
```
    Returns:
    
    true if there are no RequestTypeWithOptionsDMO items.
  - getSendsRequestHasValue
```
public boolean getSendsRequestHasValue()
```
    Returns:
    
    true if there are any RequestTypeWithOptionsDMO items.
  - getSendsRequestIterable
```
public RequestTypeWithOptionsIterableDMW getSendsRequestIterable()
```
    Returns:
    
    An Iterator of RequestTypeWithOptions objects.
  - addSendsRequest
```
public void addSendsRequest(Object value)
                     throws org.dmd.dmc.DmcValueException
```
    Adds another sendsRequest value.
    
    Parameters:
    
    value - A value compatible with RequestTypeWithOptions
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - addSendsRequest
```
public void addSendsRequest(RequestTypeWithOptions value)
```
    Adds another sendsRequest value.
    
    Parameters:
    
    value - A value compatible with RequestTypeWithOptions
  - sendsRequestContains
```
public boolean sendsRequestContains(RequestTypeWithOptions value)
```
    Returns true if the collection contains the sendsRequest value.
    
    Parameters:
    
    value - A value compatible with RequestTypeWithOptions
  - getSendsRequestCopy
```
public ArrayList<RequestTypeWithOptions> getSendsRequestCopy()
```
    Returns:
    
    A COPY of the collection of RequestTypeWithOptions objects.
  - delSendsRequest
```
public void delSendsRequest(Object value)
                     throws org.dmd.dmc.DmcValueException
```
    Deletes a sendsRequest value.
    
    Parameters:
    
    value - The RequestTypeWithOptions to be deleted from set of attribute values.
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - delSendsRequest
```
public void delSendsRequest(RequestTypeWithOptions value)
```
    Deletes a sendsRequest value.
    
    Parameters:
    
    value - The RequestTypeWithOptions to be deleted from set of attribute values.
  - remSendsRequest
```
public void remSendsRequest()
```
    Removes the sendsRequest attribute value.
  - getSubpackage
```
public String getSubpackage()
```
  - setSubpackage
```
public void setSubpackage(Object value)
                   throws org.dmd.dmc.DmcValueException
```
    Sets subpackage to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeString
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - setSubpackage
```
public void setSubpackage(String value)
```
    Sets subpackage to the specified value.
    
    Parameters:
    
    value - String
  - remSubpackage
```
public void remSubpackage()
```
    Removes the subpackage attribute value.
  - getUseBaseClass
```
public String getUseBaseClass()
```
  - setUseBaseClass
```
public void setUseBaseClass(Object value)
                     throws org.dmd.dmc.DmcValueException
```
    Sets useBaseClass to the specified value.
    
    Parameters:
    
    value - A value compatible with DmcTypeString
    
    Throws:
    
    org.dmd.dmc.DmcValueException
  - setUseBaseClass
```
public void setUseBaseClass(String value)
```
    Sets useBaseClass to the specified value.
    
    Parameters:
    
    value - String
  - remUseBaseClass
```
public void remUseBaseClass()
```
    Removes the useBaseClass attribute value.
  - getUseSchemaSize
```
public int getUseSchemaSize()
```
    Returns:
    
    The number of SchemaDefinition items.
  - getUseSchemaIsEmpty
```
public boolean getUseSchemaIsEmpty()
```
    Returns:
    
    true if there are no SchemaDefinitionDMO items.
  - getUseSchemaHasValue
```
public boolean getUseSchemaHasValue()
```
    Returns:
    
    true if there are any SchemaDefinitionDMO items.
  - getUseSchemaIterable
```
public org.dmd.dms.generated.dmw.SchemaDefinitionIterableDMW getUseSchemaIterable()
```
    Returns:
    
    An Iterator of SchemaDefinitionDMO objects.
  - addUseSchema
```
public org.dmd.dmc.DmcAttribute<?> addUseSchema(org.dmd.dms.SchemaDefinition value)
```
    Adds another useSchema value.
    
    Parameters:
    
    value - A value compatible with SchemaDefinition
  - delUseSchema
```
public void delUseSchema(org.dmd.dms.SchemaDefinition value)
```
    Deletes a useSchema value.
    
    Parameters:
    
    value - The SchemaDefinition to be deleted from set of attribute values.
  - getUseSchemaCopy
```
public ArrayList<org.dmd.dms.SchemaDefinition> getUseSchemaCopy()
```
    Returns:
    
    A COPY of the collection of SchemaDefinition objects.
  - remUseSchema
```
public void remUseSchema()
```
    Removes the useSchema attribute value.
  - getUsesRunContextItemSize
```
public int getUsesRunContextItemSize()
```
    Returns:
    
    The number of RunContextItem items.
  - getUsesRunContextItemIsEmpty
```
public boolean getUsesRunContextItemIsEmpty()
```
    Returns:
    
    true if there are no RunContextItemDMO items.
  - getUsesRunContextItemHasValue
```
public boolean getUsesRunContextItemHasValue()
```
    Returns:
    
    true if there are any RunContextItemDMO items.
  - getUsesRunContextItemIterable
```
public RunContextItemIterableDMW getUsesRunContextItemIterable()
```
    Returns:
    
    An Iterator of RunContextItemDMO objects.
  - addUsesRunContextItem
```
public org.dmd.dmc.DmcAttribute<?> addUsesRunContextItem(RunContextItem value)
```
    Adds another usesRunContextItem value.
    
    Parameters:
    
    value - A value compatible with RunContextItem
  - delUsesRunContextItem
```
public void delUsesRunContextItem(RunContextItem value)
```
    Deletes a usesRunContextItem value.
    
    Parameters:
    
    value - The RunContextItem to be deleted from set of attribute values.
  - getUsesRunContextItemCopy
```
public TreeSet<RunContextItem> getUsesRunContextItemCopy()
```
    Returns:
    
    A COPY of the collection of RunContextItem objects.
  - remUsesRunContextItem
```
public void remUsesRunContextItem()
```
    Removes the usesRunContextItem attribute value.

Class ComponentDMW

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

Constructor Summary

Method Summary

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.extended.MvwDefinition

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.generated.dmw.MvwDefinitionDMW

Methods inherited from class org.dmd.dmw.DmwWrapper

Methods inherited from class org.dmd.dmc.DmcContainer

Methods inherited from class java.lang.Object

Constructor Detail

ComponentDMW

ComponentDMW

Method Detail

getModificationRecorder

getDMO

getObjectName

hashCode

getObjectNameAttribute

equals

getComponentName

setComponentName

setComponentName

remComponentName

getFiresEventSize

getFiresEventIsEmpty

getFiresEventHasValue

getFiresEvent

getFiresEventFirstKey

getFiresEventIterable

addFiresEvent

delFiresEvent

getFiresEventCopy

remFiresEvent

getHandlesEventSize

getHandlesEventIsEmpty

getHandlesEventHasValue

getHandlesEvent

getHandlesEventFirstKey

getHandlesEventIterable

addHandlesEvent

delHandlesEvent

getHandlesEventCopy

remHandlesEvent

getInstantiatesViewSize

getInstantiatesViewIsEmpty

getInstantiatesViewHasValue

getInstantiatesViewIterable

addInstantiatesView

delInstantiatesView

getInstantiatesViewCopy

remInstantiatesView

getSendsRequestSize

getSendsRequestIsEmpty

getSendsRequestHasValue

getSendsRequestIterable

addSendsRequest

addSendsRequest

sendsRequestContains

getSendsRequestCopy

delSendsRequest

delSendsRequest

remSendsRequest

getSubpackage

setSubpackage

setSubpackage

remSubpackage

getUseBaseClass

setUseBaseClass

setUseBaseClass

remUseBaseClass

getUseSchemaSize

getUseSchemaIsEmpty

getUseSchemaHasValue

getUseSchemaIterable

addUseSchema

delUseSchema

getUseSchemaCopy

remUseSchema

getUsesRunContextItemSize