ByteMap (CIP4 xJdfLib 0.4 API)

java.lang.Object
- org.cip4.lib.xjdf.schema.ParameterType
- - org.cip4.lib.xjdf.schema.ByteMap

All Implemented Interfaces:: Serializable

public class ByteMap
extends ParameterType
implements Serializable

Java class for ByteMap complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ByteMap">
   <complexContent>
     <extension base="{http://www.CIP4.org/JDFSchema_2_0}ParameterType">
       <sequence>
         <element ref="{http://www.CIP4.org/JDFSchema_2_0}PixelColorant" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.CIP4.org/JDFSchema_2_0}Band" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="BandOrdering" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
       <attribute name="ElementType" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
       <attribute name="Halftoned" type="{http://www.CIP4.org/JDFSchema_2_0}boolean" />
       <attribute name="Resolution" type="{http://www.CIP4.org/JDFSchema_2_0}XYPair" />
       <attribute name="FrameWidth" type="{http://www.CIP4.org/JDFSchema_2_0}integer" />
       <attribute name="Interleaved" type="{http://www.CIP4.org/JDFSchema_2_0}boolean" />
       <attribute name="FrameHeight" type="{http://www.CIP4.org/JDFSchema_2_0}integer" />
       <attribute name="PixelSkip" type="{http://www.CIP4.org/JDFSchema_2_0}integer" />
       <attribute name="FileSpecRef" type="{http://www.CIP4.org/JDFSchema_2_0}IDREF" />
       <attribute name="ColorRef" type="{http://www.CIP4.org/JDFSchema_2_0}IDREF" />
     </extension>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Band>`	`band`
`protected String`	`bandOrdering`
`protected Object`	`colorRef`
`protected String`	`elementType`
`protected Object`	`fileSpecRef`
`protected Integer`	`frameHeight`
`protected Integer`	`frameWidth`
`protected Boolean`	`halftoned`
`protected Boolean`	`interleaved`
`protected List<PixelColorant>`	`pixelColorant`
`protected Integer`	`pixelSkip`
`protected XYPair`	`resolution`

Constructor Summary

Constructors
Constructor and Description

ByteMap()

Constructors
Constructor and Description
`ByteMap()`

Method Summary

Methods
Modifier and Type	Method and Description
`List<Band>`	`getBand()` Gets the value of the band property.
`String`	`getBandOrdering()` Gets the value of the bandOrdering property.
`Object`	`getColorRef()` Gets the value of the colorRef property.
`String`	`getElementType()` Gets the value of the elementType property.
`Object`	`getFileSpecRef()` Gets the value of the fileSpecRef property.
`Integer`	`getFrameHeight()` Gets the value of the frameHeight property.
`Integer`	`getFrameWidth()` Gets the value of the frameWidth property.
`List<PixelColorant>`	`getPixelColorant()` Gets the value of the pixelColorant property.
`Integer`	`getPixelSkip()` Gets the value of the pixelSkip property.
`XYPair`	`getResolution()` Gets the value of the resolution property.
`Boolean`	`isHalftoned()` Gets the value of the halftoned property.
`Boolean`	`isInterleaved()` Gets the value of the interleaved property.
`void`	`setBandOrdering(String value)` Sets the value of the bandOrdering property.
`void`	`setColorRef(Object value)` Sets the value of the colorRef property.
`void`	`setElementType(String value)` Sets the value of the elementType property.
`void`	`setFileSpecRef(Object value)` Sets the value of the fileSpecRef property.
`void`	`setFrameHeight(Integer value)` Sets the value of the frameHeight property.
`void`	`setFrameWidth(Integer value)` Sets the value of the frameWidth property.
`void`	`setHalftoned(Boolean value)` Sets the value of the halftoned property.
`void`	`setInterleaved(Boolean value)` Sets the value of the interleaved property.
`void`	`setPixelSkip(Integer value)` Sets the value of the pixelSkip property.
`void`	`setResolution(XYPair value)` Sets the value of the resolution property.

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

- Field Detail
  - pixelColorant
```
protected List<PixelColorant> pixelColorant
```
  - band
```
protected List<Band> band
```
  - bandOrdering
```
protected String bandOrdering
```
  - elementType
```
protected String elementType
```
  - halftoned
```
protected Boolean halftoned
```
  - resolution
```
protected XYPair resolution
```
  - frameWidth
```
protected Integer frameWidth
```
  - interleaved
```
protected Boolean interleaved
```
  - frameHeight
```
protected Integer frameHeight
```
  - pixelSkip
```
protected Integer pixelSkip
```
  - fileSpecRef
```
protected Object fileSpecRef
```
  - colorRef
```
protected Object colorRef
```
- Constructor Detail
  - ByteMap
```
public ByteMap()
```
- Method Detail
  - getPixelColorant
```
public List<PixelColorant> getPixelColorant()
```
    Gets the value of the pixelColorant property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the pixelColorant property.
    For example, to add a new item, do as follows:
```
    getPixelColorant().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list PixelColorant
  - getBand
```
public List<Band> getBand()
```
    Gets the value of the band property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the band property.
    For example, to add a new item, do as follows:
```
    getBand().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Band
  - getBandOrdering
```
public String getBandOrdering()
```
    Gets the value of the bandOrdering property.
    
    Returns:
    possible object is String
  - setBandOrdering
```
public void setBandOrdering(String value)
```
    Sets the value of the bandOrdering property.
    
    Parameters:
    value - allowed object is String
  - getElementType
```
public String getElementType()
```
    Gets the value of the elementType property.
    
    Returns:
    possible object is String
  - setElementType
```
public void setElementType(String value)
```
    Sets the value of the elementType property.
    
    Parameters:
    value - allowed object is String
  - isHalftoned
```
public Boolean isHalftoned()
```
    Gets the value of the halftoned property.
    
    Returns:
    possible object is Boolean
  - setHalftoned
```
public void setHalftoned(Boolean value)
```
    Sets the value of the halftoned property.
    
    Parameters:
    value - allowed object is Boolean
  - getResolution
```
public XYPair getResolution()
```
    Gets the value of the resolution property.
    
    Returns:
    possible object is String
  - setResolution
```
public void setResolution(XYPair value)
```
    Sets the value of the resolution property.
    
    Parameters:
    value - allowed object is String
  - getFrameWidth
```
public Integer getFrameWidth()
```
    Gets the value of the frameWidth property.
    
    Returns:
    possible object is Integer
  - setFrameWidth
```
public void setFrameWidth(Integer value)
```
    Sets the value of the frameWidth property.
    
    Parameters:
    value - allowed object is Integer
  - isInterleaved
```
public Boolean isInterleaved()
```
    Gets the value of the interleaved property.
    
    Returns:
    possible object is Boolean
  - setInterleaved
```
public void setInterleaved(Boolean value)
```
    Sets the value of the interleaved property.
    
    Parameters:
    value - allowed object is Boolean
  - getFrameHeight
```
public Integer getFrameHeight()
```
    Gets the value of the frameHeight property.
    
    Returns:
    possible object is Integer
  - setFrameHeight
```
public void setFrameHeight(Integer value)
```
    Sets the value of the frameHeight property.
    
    Parameters:
    value - allowed object is Integer
  - getPixelSkip
```
public Integer getPixelSkip()
```
    Gets the value of the pixelSkip property.
    
    Returns:
    possible object is Integer
  - setPixelSkip
```
public void setPixelSkip(Integer value)
```
    Sets the value of the pixelSkip property.
    
    Parameters:
    value - allowed object is Integer
  - getFileSpecRef
```
public Object getFileSpecRef()
```
    Gets the value of the fileSpecRef property.
    
    Returns:
    possible object is Object
  - setFileSpecRef
```
public void setFileSpecRef(Object value)
```
    Sets the value of the fileSpecRef property.
    
    Parameters:
    value - allowed object is Object
  - getColorRef
```
public Object getColorRef()
```
    Gets the value of the colorRef property.
    
    Returns:
    possible object is Object
  - setColorRef
```
public void setColorRef(Object value)
```
    Sets the value of the colorRef property.
    
    Parameters:
    value - allowed object is Object

Class ByteMap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pixelColorant

band

bandOrdering

elementType

halftoned

resolution

frameWidth

interleaved

frameHeight

pixelSkip

fileSpecRef

colorRef

Constructor Detail

ByteMap

Method Detail

getPixelColorant

getBand

getBandOrdering

setBandOrdering

getElementType

setElementType

isHalftoned

setHalftoned

getResolution

setResolution

getFrameWidth

setFrameWidth

isInterleaved

setInterleaved

getFrameHeight

setFrameHeight

getPixelSkip

setPixelSkip

getFileSpecRef

setFileSpecRef

getColorRef

setColorRef