|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractMap<K,V>
java.util.HashMap<K,V>
java.util.LinkedHashMap<java.lang.Object,Dimension>
clarion.system.DimensionValueCollection
clarion.system.AbstractChunk
public abstract class AbstractChunk
This class implements a chunk within CLARION. It extends the DimensionValueCollection class. This class is abstract and therefore cannot be instantiated on its own.
Usage:
In it's most basic form, a chunk is essentially just a dimension-value collection that contains an ID. It is a representational object used most often by the top level of the various CLARION subsystems. In addition, some chunks may be linked to the output side of various explicit and implicit modules and can be used to pass pertinent information and instructions between the subsystems.
It is required that you specify a way of identifying the chunk (eg. name, number, etc) when you initialize this class. Once this ID is set, it cannot be changed. This ID is used as the key for this chunk when it is placed inside a map.
Known Subclasses:
Field Summary | |
---|---|
private java.lang.Object |
ID
Identifies the chunk. |
private static long |
serialVersionUID
|
Constructor Summary | |
---|---|
AbstractChunk(java.lang.Object id)
Initializes the chunk with the ID specified. |
|
AbstractChunk(java.lang.Object id,
java.util.Collection<? extends Dimension> dims)
Initializes the chunk with the specified ID and dimensions. |
|
AbstractChunk(java.lang.Object id,
java.util.Map<? extends java.lang.Object,? extends Dimension> dims)
Initializes the chunk with the specified ID and map of dimensions. |
Method Summary | |
---|---|
abstract AbstractChunk |
clone()
Clones the chunk (including all of it's dimensions). |
boolean |
equals(java.lang.Object chunk)
Checks to see if the specified object is a chunk and if the ID of the specified chunk is the same as this chunk. |
boolean |
equalsID(java.lang.Object chunk)
Checks to see if the specified chunk has the same ID as this chunk. |
java.lang.Object |
getID()
Gets the ID of this chunk. |
java.lang.String |
toString()
|
Methods inherited from class clarion.system.DimensionValueCollection |
---|
containsKeys, getNumDVPairs, getValueCollection, hashCode, put, putAll, size |
Methods inherited from class java.util.LinkedHashMap |
---|
clear, containsValue, get, removeEldestEntry |
Methods inherited from class java.util.HashMap |
---|
containsKey, entrySet, isEmpty, keySet, remove, values |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Map |
---|
containsKey, entrySet, isEmpty, keySet, remove, values |
Field Detail |
---|
private static final long serialVersionUID
private java.lang.Object ID
Constructor Detail |
---|
public AbstractChunk(java.lang.Object id)
id
- The ID of the chunk.public AbstractChunk(java.lang.Object id, java.util.Collection<? extends Dimension> dims)
id
- The ID of the chunk.dims
- The dimensions for the chunk.public AbstractChunk(java.lang.Object id, java.util.Map<? extends java.lang.Object,? extends Dimension> dims)
id
- The ID of the chunk.dims
- The map of dimensions for the chunk.Method Detail |
---|
public java.lang.Object getID()
public boolean equalsID(java.lang.Object chunk)
chunk
- The chunk whose ID you want to compare to this chunk's ID.
public boolean equals(java.lang.Object chunk)
equals
in interface java.util.Map<java.lang.Object,Dimension>
equals
in class DimensionValueCollection
chunk
- The object to compare to this chunk.
public abstract AbstractChunk clone()
clone
in class DimensionValueCollection
public java.lang.String toString()
toString
in class DimensionValueCollection
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |