Class AbstractNamedAFPObject

java.lang.Object

org.apache.fop.afp.modca.AbstractAFPObject

org.apache.fop.afp.modca.AbstractStructuredObject

org.apache.fop.afp.modca.AbstractTripletStructuredObject

org.apache.fop.afp.modca.AbstractNamedAFPObject

All Implemented Interfaces:

Streamable

Direct Known Subclasses:

AbstractDataObject, AbstractEnvironmentGroup, AbstractGraphicsDrawingOrderContainer, AbstractPageObject, ImageSegment, IMImageObject, IncludedResourceObject, IncludeObject, IncludePageOverlay, IncludePageSegment, InvokeMediumMap, ObjectEnvironmentGroup, PageSegment, PresentationTextObject, ResourceGroup, ResourceObject

public abstract class AbstractNamedAFPObject
extends AbstractTripletStructuredObject

This is the base class for all named data stream objects. A named data stream object has an 8 byte EBCIDIC name.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAFPObject

AbstractAFPObject.Category, AbstractAFPObject.Type

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	DEFAULT_NAME_LENGTH
protected String	name	The actual name of the object

Fields inherited from class AbstractTripletStructuredObject

triplets

Fields inherited from class AbstractAFPObject

LOG, SF_CLASS, SF_HEADER_LENGTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNamedAFPObject()	Default constructor
protected	AbstractNamedAFPObject(String name)	Constructor for the ActiveEnvironmentGroup, this takes a name parameter which should be 8 characters long.

Method Summary

Modifier and Type	Method	Description
protected void	copySF(byte[] data, byte type, byte category)	Copies the template structured field data array to the given byte array
String	getName()	Returns the name of this object
byte[]	getNameBytes()	Returns the name as a byte array in EBCIDIC encoding
protected int	getNameLength()	Returns the name length
void	setName(String name)	Sets the name of this object
String	toString()

Methods inherited from class AbstractTripletStructuredObject

addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setFullyQualifiedName, setObjectClassification, writeTriplets

Methods inherited from class AbstractStructuredObject

writeContent, writeEnd, writeStart, writeToStream

Methods inherited from class AbstractAFPObject

copySF, truncate, writeChunksToStream, writeObjects

Methods inherited from class Object

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

Field Details

DEFAULT_NAME_LENGTH

private static final int DEFAULT_NAME_LENGTH

See Also:

• Constant Field Values

name

protected String name

The actual name of the object

Constructor Details

AbstractNamedAFPObject

protected AbstractNamedAFPObject()

Default constructor

AbstractNamedAFPObject

protected AbstractNamedAFPObject(String name)

Constructor for the ActiveEnvironmentGroup, this takes a name parameter which should be 8 characters long.

Parameters:

name - the object name

Method Details

getNameLength

protected int getNameLength()

Returns the name length

Returns:

the name length

getNameBytes

public byte[] getNameBytes()

Returns the name as a byte array in EBCIDIC encoding

Returns:

the name as a byte array in EBCIDIC encoding

copySF

protected void copySF(byte[] data,
 byte type,
 byte category)

Description copied from class: AbstractAFPObject

Copies the template structured field data array to the given byte array

Overrides:

copySF in class AbstractAFPObject

Parameters:

data - the structured field data byte array

type - the type code

category - the category code

getName

public String getName()

Returns the name of this object

Returns:

the name of this object

setName

public void setName(String name)

Sets the name of this object

Parameters:

name - the object name

toString

public String toString()

Overrides:

toString in class Object