triana.types

Class TrianaPixelMap

java.lang.Object

triana.types.TrianaType

triana.types.TrianaPixelMap

All Implemented Interfaces:

java.io.Serializable, SequenceInterface

Direct Known Subclasses:

ImageMap

public class TrianaPixelMap
extends TrianaType

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
PixelMap	pixelMap Obsolete parameter kept for compatibility with older version of this class.

Fields inherited from class triana.types.TrianaType

NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors

Constructor and Description
TrianaPixelMap() Default constructor.
TrianaPixelMap(java.awt.Image image) Constuctor using an Image
TrianaPixelMap(PixelMap pixelMap) Constuctor using a PixelMap
TrianaPixelMap(TrianaImage trianaImage) Constuctor using a TrianaImage
TrianaPixelMap(TrianaPixelMap trianaPixelMap) Constuctor using a TrianaPixelMap

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyData(TrianaType source) Implement the abstract copyData method of TrianaType.
TrianaType	copyMe() This is one of the most important methods of Triana data.
protected void	copyParameters(TrianaType source) Over-ride the copyParameters method to copy the parameter valid.
PixelMap	getPixelMap()
TrianaImage	getTrianaImage()
boolean	isValid() This function is used by the Op class to check if the data contained within the particular Triana Type is valid or not.
void	setPixelMap(PixelMap px) Sets the given PixelMap into the current Object
protected void	updateObsoletePointers()

Methods inherited from class triana.types.TrianaType

containerSize, dataExists, deleteFromContainer, getDataContainer, getFromContainer, getSequenceNumber, insertIntoContainer, inspectDataContainer, setDataContainer, setSequenceNumber

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pixelMap

public PixelMap pixelMap

Obsolete parameter kept for compatibility with older version of this class. It is obsolete because the main data is now stored in dataContainer, not as a public object. Constructors and data setting methods keep this pointer up to date with changes in the object held in dataContainer.

Constructor Detail

TrianaPixelMap

public TrianaPixelMap()

Default constructor.

TrianaPixelMap

public TrianaPixelMap(PixelMap pixelMap)

Constuctor using a PixelMap

Parameters:

pixelMap - The input PixelMap

TrianaPixelMap

public TrianaPixelMap(TrianaPixelMap trianaPixelMap)

Constuctor using a TrianaPixelMap

Parameters:

trianaPixelMap - The input TrianaPixelMap

TrianaPixelMap

public TrianaPixelMap(java.awt.Image image)

Constuctor using an Image

Parameters:

image - The input Image

TrianaPixelMap

public TrianaPixelMap(TrianaImage trianaImage)

Constuctor using a TrianaImage

Parameters:

trianaImage - The input TrianaImage

Method Detail

isValid

public boolean isValid()

This function is used by the Op class to check if the data contained within the particular Triana Type is valid or not. This check is dependant on the type of data the Triana type is representing so it must be implemented within each individual type.

copyMe

public TrianaType copyMe()

This is one of the most important methods of Triana data. types. It returns a copy of the type invoking it. This must be overridden for every derived data type derived. If not, the data cannot be copied to be given to other units. Copying must be done by value, not by reference.

To override, the programmer should not invoke the super.copyMe method. Instead, create an object of the current type and call methods copyData and copyParameters. If these have been written correctly, then they will do the copying. The code should createTool, for type YourType:

 YourType y = null; try { y =
 (YourType)getClass().newInstance(); y.copyData( this ); y.copyParameters( this ); y.setLegend( this.getLegend()
 ); } catch (IllegalAccessException ee) { System.out.println("Illegal Access: " + ee.getMessage()); } catch
 (InstantiationException ee) { System.out.println("Couldn't be instantiated: " + ee.getMessage()); } return y;
 

The copied object's data should be identical to the original. The method here modifies only one item: a String indicating that the object was created as a copy is added to the description StringVector.

Specified by:

copyMe in class TrianaType

Returns:

TrianaType Copy by value of the current Object except for an updated description

copyData

protected void copyData(TrianaType source)

Implement the abstract copyData method of TrianaType. This copies an image from the given object to the present one.

Overrides:

copyData in class TrianaType

Parameters:

source - The TrianaImage whose image is being copied

copyParameters

protected void copyParameters(TrianaType source)

Over-ride the copyParameters method to copy the parameter valid.

Overrides:

copyParameters in class TrianaType

Parameters:

source - The object from which the copy will be made

getPixelMap

public PixelMap getPixelMap()

Returns:

the PixelMap Object contained within this type.

getTrianaImage

public TrianaImage getTrianaImage()

Returns:

TrianaImage an Object containing the image described by this type.

See Also:

TrianaImage

setPixelMap

public void setPixelMap(PixelMap px)

Sets the given PixelMap into the current Object

Parameters:

px - the object to be inserted

updateObsoletePointers

protected void updateObsoletePointers()

Overrides:

updateObsoletePointers in class TrianaType