xmlgraphics-commons 1.3.1

org.apache.xmlgraphics.ps.dsc
Class ResourceTracker

java.lang.Object
  extended by org.apache.xmlgraphics.ps.dsc.ResourceTracker

public class ResourceTracker
extends java.lang.Object

This class is used to track resources in a DSC-compliant PostScript file. The distinction is made between supplied and needed resources. For the details of this distinction, please see the DSC specification.


Constructor Summary
ResourceTracker()
           
 
Method Summary
 java.util.Set getDocumentNeededResources()
          Returns the set of needed resources.
 java.util.Set getDocumentSuppliedResources()
          Returns the set of supplied resources.
 boolean isResourceSupplied(PSResource res)
          Indicates whether a particular resource is supplied, rather than needed.
 void notifyResourceUsageOnPage(java.util.Collection resources)
          Notifies the resource tracker about the usage of resources on the current page.
 void notifyResourceUsageOnPage(PSResource res)
          Notifies the resource tracker about the usage of a resource on the current page.
 void notifyStartNewPage()
          Notifies the resource tracker that a new page has been started and that the page resource set can be cleared.
 void registerNeededResource(PSResource res)
          Registers a needed resource.
 void registerSuppliedResource(PSResource res)
          Registers a supplied resource.
 void writeResources(boolean pageLevel, PSGenerator gen)
          Writes a DSC comment for the accumulated used resources, either at page level or at document level.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResourceTracker

public ResourceTracker()
Method Detail

getDocumentSuppliedResources

public java.util.Set getDocumentSuppliedResources()
Returns the set of supplied resources.

Returns:
the set of supplied resources

getDocumentNeededResources

public java.util.Set getDocumentNeededResources()
Returns the set of needed resources.

Returns:
the set of needed resources

notifyStartNewPage

public void notifyStartNewPage()
Notifies the resource tracker that a new page has been started and that the page resource set can be cleared.


registerSuppliedResource

public void registerSuppliedResource(PSResource res)
Registers a supplied resource. If the same resources is already in the set of needed resources, it is removed there.

Parameters:
res - the resource

registerNeededResource

public void registerNeededResource(PSResource res)
Registers a needed resource. If the same resources is already in the set of supplied resources, it is ignored, i.e. it is assumed to be supplied.

Parameters:
res - the resource

notifyResourceUsageOnPage

public void notifyResourceUsageOnPage(PSResource res)
Notifies the resource tracker about the usage of a resource on the current page.

Parameters:
res - the resource being used

notifyResourceUsageOnPage

public void notifyResourceUsageOnPage(java.util.Collection resources)
Notifies the resource tracker about the usage of resources on the current page.

Parameters:
resources - the resources being used

isResourceSupplied

public boolean isResourceSupplied(PSResource res)
Indicates whether a particular resource is supplied, rather than needed.

Parameters:
res - the resource
Returns:
true if the resource is registered as being supplied.

writeResources

public void writeResources(boolean pageLevel,
                           PSGenerator gen)
                    throws java.io.IOException
Writes a DSC comment for the accumulated used resources, either at page level or at document level.

Parameters:
pageLevel - true if the DSC comment for the page level should be generated, false for the document level (in the trailer)
gen - the PSGenerator to write the DSC comments with
Throws:
java.io.IOException - In case of an I/O problem

xmlgraphics-commons 1.3.1

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.