org.apache.camel.dataformat.barcode

Class BarcodeDataFormat

java.lang.Object

org.apache.camel.dataformat.barcode.BarcodeDataFormat

All Implemented Interfaces:

org.apache.camel.spi.DataFormat

public class BarcodeDataFormat
extends Object
implements org.apache.camel.spi.DataFormat

DataFormat to create (encode) and read (decode) barcodes. For more info about the available barcodes have a look at:

https://github.com/zxing/zxing

Constructor Summary

Constructors

Constructor and Description
BarcodeDataFormat() Create instance with default parameters.
BarcodeDataFormat(com.google.zxing.BarcodeFormat format) Create instance with custom BarcodeFormat.
BarcodeDataFormat(BarcodeImageType type) Create instance with custom BarcodeImageType.
BarcodeDataFormat(int width, int height) Create instance with custom height and width.
BarcodeDataFormat(int width, int height, BarcodeImageType type, com.google.zxing.BarcodeFormat format) Create instance with custom height, width and image type.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToHintMap(com.google.zxing.DecodeHintType hintType, Object value) Adds a new hint value to reader (decode) hint map.
void	addToHintMap(com.google.zxing.EncodeHintType hintType, Object value) Adds a new hint value to writer (encode) hint map.
BarcodeParameters	getParams() The (default) parameters.
Map<com.google.zxing.DecodeHintType,Object>	getReaderHintMap() The reader (decode) hint map.
Map<com.google.zxing.EncodeHintType,Object>	getWriterHintMap() The writer (encode) hint map.
void	marshal(org.apache.camel.Exchange exchange, Object graph, OutputStream stream) Marshall a String payload to a code image.
protected void	optimizeHints() Sets hints optimized for different barcode types.
void	removeFromHintMap(com.google.zxing.DecodeHintType hintType) Removes a hint from reader (decode) hint map.
void	removeFromHintMap(com.google.zxing.EncodeHintType hintType) Removes a hint from writer (encode) hint map.
void	setBarcodeFormat(com.google.zxing.BarcodeFormat format)
void	setBarcodeImageType(BarcodeImageType type)
protected void	setDefaultParameters() Sets the default parameters.
void	setHeight(Integer height)
void	setWidth(Integer width)
Object	unmarshal(org.apache.camel.Exchange exchange, InputStream stream) Unmarshall a code image to a String payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

BarcodeDataFormat

public BarcodeDataFormat()

Create instance with default parameters.

BarcodeDataFormat

public BarcodeDataFormat(com.google.zxing.BarcodeFormat format)

Create instance with custom BarcodeFormat. The other values are default.

Parameters:

format - the barcode format

BarcodeDataFormat

public BarcodeDataFormat(int width,
                 int height)

Create instance with custom height and width. The other values are default.

Parameters:

height - the image height

width - the image width

BarcodeDataFormat

public BarcodeDataFormat(BarcodeImageType type)

Create instance with custom BarcodeImageType. The other values are default.

Parameters:

type - the type (format) of the image. e.g. PNG

BarcodeDataFormat

public BarcodeDataFormat(int width,
                 int height,
                 BarcodeImageType type,
                 com.google.zxing.BarcodeFormat format)

Create instance with custom height, width and image type. The other values are default.

Parameters:

height - the image height

width - the image width

type - the type (format) of the image. e.g. PNG

format - the barcode format

Method Detail

marshal

public void marshal(org.apache.camel.Exchange exchange,
           Object graph,
           OutputStream stream)
             throws Exception

Marshall a String payload to a code image.

Specified by:

marshal in interface org.apache.camel.spi.DataFormat

Parameters:

exchange -

graph -

stream -

Throws:

Exception

unmarshal

public Object unmarshal(org.apache.camel.Exchange exchange,
               InputStream stream)
                 throws Exception

Unmarshall a code image to a String payload.

Specified by:

unmarshal in interface org.apache.camel.spi.DataFormat

Parameters:

exchange -

stream -

Returns:

Throws:

Exception

setDefaultParameters

protected final void setDefaultParameters()

Sets the default parameters.

optimizeHints

protected final void optimizeHints()

Sets hints optimized for different barcode types.

addToHintMap

public final void addToHintMap(com.google.zxing.EncodeHintType hintType,
                Object value)

Adds a new hint value to writer (encode) hint map.

Parameters:

hintType -

value -

addToHintMap

public final void addToHintMap(com.google.zxing.DecodeHintType hintType,
                Object value)

Adds a new hint value to reader (decode) hint map.

Parameters:

hintType -

value -

removeFromHintMap

public final void removeFromHintMap(com.google.zxing.EncodeHintType hintType)

Removes a hint from writer (encode) hint map.

Parameters:

hintType -

removeFromHintMap

public final void removeFromHintMap(com.google.zxing.DecodeHintType hintType)

Removes a hint from reader (decode) hint map.

Parameters:

hintType -

getParams

public final BarcodeParameters getParams()

The (default) parameters.

Returns:

getWriterHintMap

public final Map<com.google.zxing.EncodeHintType,Object> getWriterHintMap()

The writer (encode) hint map.

Returns:

getReaderHintMap

public final Map<com.google.zxing.DecodeHintType,Object> getReaderHintMap()

The reader (decode) hint map.

Returns:

setBarcodeImageType

public void setBarcodeImageType(BarcodeImageType type)

setBarcodeFormat

public void setBarcodeFormat(com.google.zxing.BarcodeFormat format)

setWidth

public void setWidth(Integer width)

setHeight

public void setHeight(Integer height)