Class ResourceGroup

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

org.apache.fop.afp.modca.ResourceGroup

All Implemented Interfaces:

Streamable

Direct Known Subclasses:

StreamedResourceGroup

public class ResourceGroup
extends AbstractNamedAFPObject

A Resource Group contains a set of overlays.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAFPObject

AbstractAFPObject.Category, AbstractAFPObject.Type

Field Summary

Fields

Modifier and Type	Field	Description
private final Set<AbstractNamedAFPObject>	resourceSet	Set of resource uri

Fields inherited from class AbstractNamedAFPObject

name

Fields inherited from class AbstractTripletStructuredObject

triplets

Fields inherited from class AbstractAFPObject

LOG, SF_CLASS, SF_HEADER_LENGTH

Constructor Summary

Constructors

Constructor	Description
ResourceGroup(String name)	Constructor for the ResourceGroup, this takes a name parameter which must be 8 characters long.

Method Summary

Modifier and Type	Method	Description
void	addObject(AbstractNamedAFPObject namedObject)	Add this named object to this resource group
int	getResourceCount()	Returns the number of resources contained in this resource group
String	toString()
void	writeContent(OutputStream os)	Helper method to write the contents of the Object.
void	writeEnd(OutputStream os)	Helper method to write the end of the Object.
void	writeStart(OutputStream os)	Helper method to write the start of the Object.

Methods inherited from class AbstractNamedAFPObject

copySF, getName, getNameBytes, getNameLength, setName

Methods inherited from class AbstractTripletStructuredObject

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

Methods inherited from class AbstractStructuredObject

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

resourceSet

private final Set<AbstractNamedAFPObject> resourceSet

Set of resource uri

Constructor Details

ResourceGroup

public ResourceGroup(String name)

Constructor for the ResourceGroup, this takes a name parameter which must be 8 characters long.

Parameters:

name - the resource group name

Method Details

addObject

public void addObject(AbstractNamedAFPObject namedObject)
               throws IOException

Add this named object to this resource group

Parameters:

namedObject - a named object

Throws:

IOException - thrown if an I/O exception of some sort has occurred.

getResourceCount

public int getResourceCount()

Returns the number of resources contained in this resource group

Returns:

the number of resources contained in this resource group

writeStart

public void writeStart(OutputStream os)
                throws IOException

Helper method to write the start of the Object.

Overrides:

writeStart in class AbstractStructuredObject

Parameters:

os - The stream to write to

Throws:

IOException - throws an I/O exception if one occurred

writeContent

public void writeContent(OutputStream os)
                  throws IOException

Helper method to write the contents of the Object.

Overrides:

writeContent in class AbstractStructuredObject

Parameters:

os - The stream to write to

Throws:

IOException - throws an I/O exception if one occurred

writeEnd

public void writeEnd(OutputStream os)
              throws IOException

Helper method to write the end of the Object.

Overrides:

writeEnd in class AbstractStructuredObject

Parameters:

os - The stream to write to

Throws:

IOException - an I/O exception if one occurred

toString

public String toString()

Overrides:

toString in class AbstractNamedAFPObject