Package org.apache.fop.afp.modca
Class AbstractTripletStructuredObject
java.lang.Object
org.apache.fop.afp.modca.AbstractAFPObject
org.apache.fop.afp.modca.AbstractStructuredObject
org.apache.fop.afp.modca.AbstractTripletStructuredObject
- All Implemented Interfaces:
Streamable
- Direct Known Subclasses:
AbstractDescriptor
,AbstractNamedAFPObject
,MapContainerData
,MapDataResource
,MapImageObject
,PreprocessPresentationObject
,PresentationEnvironmentControl
,TagLogicalElement
A MODCA structured object base class providing support for Triplets
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject
AbstractAFPObject.Category, AbstractAFPObject.Type
-
Field Summary
Fields inherited from class org.apache.fop.afp.modca.AbstractAFPObject
LOG, SF_CLASS, SF_HEADER_LENGTH
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addTriplet
(AbstractTriplet triplet) Adds a triplet to this structured objectvoid
addTriplets
(Collection<AbstractTriplet> tripletCollection) Adds a list of triplets to the triplets contained within this structured fieldprotected int
Returns the triplet data lengthprotected List<AbstractTriplet>
boolean
hasTriplet
(byte tripletId) Returns true of this structured field has the given tripletboolean
Returns true when this structured field contains tripletsvoid
setComment
(String commentString) Sets a comment on this resourcevoid
setFullyQualifiedName
(byte fqnType, byte fqnFormat, String fqName) Sets the fully qualified name of this structured fieldvoid
setFullyQualifiedName
(byte fqnType, byte fqnFormat, String fqName, boolean utf16be) void
setObjectClassification
(byte objectClass, Registry.ObjectType objectType, boolean dataInContainer, boolean containerHasOEG, boolean dataInOCD) Sets the objects classificationprotected void
Writes any triplet dataMethods inherited from class org.apache.fop.afp.modca.AbstractStructuredObject
writeContent, writeEnd, writeStart, writeToStream
Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, copySF, truncate, writeChunksToStream, writeObjects
-
Field Details
-
triplets
list of object triplets
-
-
Constructor Details
-
AbstractTripletStructuredObject
public AbstractTripletStructuredObject()
-
-
Method Details
-
getTripletDataLength
protected int getTripletDataLength()Returns the triplet data length- Returns:
- the triplet data length
-
hasTriplets
public boolean hasTriplets()Returns true when this structured field contains triplets- Returns:
- true when this structured field contains triplets
-
writeTriplets
Writes any triplet data- Parameters:
os
- The stream to write to- Throws:
IOException
- The stream to write to
-
hasTriplet
public boolean hasTriplet(byte tripletId) Returns true of this structured field has the given triplet- Parameters:
tripletId
- the triplet identifier- Returns:
- true if the structured field has the given triplet
-
addTriplet
Adds a triplet to this structured object- Parameters:
triplet
- the triplet to add
-
addTriplets
Adds a list of triplets to the triplets contained within this structured field- Parameters:
tripletCollection
- a collection of triplets
-
getTriplets
- Returns:
- the triplet list pertaining to this resource
-
setFullyQualifiedName
Sets the fully qualified name of this structured field- Parameters:
fqnType
- the fully qualified name type of this resourcefqnFormat
- the fully qualified name format of this resourcefqName
- the fully qualified name of this resource
-
setFullyQualifiedName
-
getFullyQualifiedName
- Returns:
- the fully qualified name of this triplet or null if it does not exist
-
setObjectClassification
public void setObjectClassification(byte objectClass, Registry.ObjectType objectType, boolean dataInContainer, boolean containerHasOEG, boolean dataInOCD) Sets the objects classification- Parameters:
objectClass
- the classification of the objectobjectType
- the MOD:CA registry object type entry for the given object/component type of the objectdataInContainer
- whether the data resides in the containercontainerHasOEG
- whether the container has an object environment groupdataInOCD
- whether the data resides in a object container data structured field
-
setComment
Sets a comment on this resource- Parameters:
commentString
- a comment string
-