Package org.apache.fop.afp.modca
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 org.apache.fop.afp.modca.AbstractAFPObject
AbstractAFPObject.Category, AbstractAFPObject.Type
-
-
Field Summary
Fields Modifier and Type Field Description private static int
DEFAULT_NAME_LENGTH
protected java.lang.String
name
The actual name of the object-
Fields inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
triplets
-
Fields inherited from class org.apache.fop.afp.modca.AbstractAFPObject
LOG, SF_CLASS, SF_HEADER_LENGTH
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractNamedAFPObject()
Default constructorprotected
AbstractNamedAFPObject(java.lang.String name)
Constructor for the ActiveEnvironmentGroup, this takes a name parameter which should be 8 characters long.
-
Method Summary
All Methods Instance Methods Concrete Methods 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 arrayjava.lang.String
getName()
Returns the name of this objectbyte[]
getNameBytes()
Returns the name as a byte array in EBCIDIC encodingprotected int
getNameLength()
Returns the name lengthvoid
setName(java.lang.String name)
Sets the name of this objectjava.lang.String
toString()
-
Methods inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setFullyQualifiedName, setObjectClassification, writeTriplets
-
Methods inherited from class org.apache.fop.afp.modca.AbstractStructuredObject
writeContent, writeEnd, writeStart, writeToStream
-
Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, truncate, writeChunksToStream, writeObjects
-
-
-
-
Field Detail
-
DEFAULT_NAME_LENGTH
private static final int DEFAULT_NAME_LENGTH
- See Also:
- Constant Field Values
-
name
protected java.lang.String name
The actual name of the object
-
-
Constructor Detail
-
AbstractNamedAFPObject
protected AbstractNamedAFPObject()
Default constructor
-
AbstractNamedAFPObject
protected AbstractNamedAFPObject(java.lang.String name)
Constructor for the ActiveEnvironmentGroup, this takes a name parameter which should be 8 characters long.- Parameters:
name
- the object name
-
-
Method Detail
-
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 classAbstractAFPObject
- Parameters:
data
- the structured field data byte arraytype
- the type codecategory
- the category code
-
getName
public java.lang.String getName()
Returns the name of this object- Returns:
- the name of this object
-
setName
public void setName(java.lang.String name)
Sets the name of this object- Parameters:
name
- the object name
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-