Package org.xj3d.impl.core.loading

Class WorldLoadHandler

java.lang.Object

org.xj3d.impl.core.loading.WorldLoadHandler

All Implemented Interfaces:

LoadRequestHandler, ReadProgressListener

public class WorldLoadHandler
extends Object
implements LoadRequestHandler, ReadProgressListener

Independent thread used to load a world from a list of URLs and then place it in the given node.

This implementation is designed to work as both a loadURL() and createVrmlFromUrl() call handler. The difference is defined by what data is supplied to the thread. If the target node is specified, then we assume that the caller wants us to put the results there. If it is null, then assume that we're doing a loadURL call and replace the entire world.

Version:

$Revision: 1.4 $

Author:

Justin Couch

Constructor Summary

Constructors

Constructor	Description
WorldLoadHandler(FileCache cache)	Create a new empty world loader.

Method Summary

Modifier and Type	Method	Description
void	abortCurrentFile()	Notification to abort loading the current resource.
void	processLoadRequest(org.j3d.util.ErrorReporter reporter, String[] urls, Vector<LoadDetails> loadList)	Process this load request now.
void	progressUpdate(long value)	Notification of where the stream is at.
void	shutdown()	Notification to shut down the load process entirely for this thread.
void	streamClosed()	The stream has closed.

Methods inherited from class java.lang.Object

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

Constructor Details

WorldLoadHandler

public WorldLoadHandler(FileCache cache)

Create a new empty world loader. It does not start the thread running. That is the job of the caller code.

Parameters:

cache - The file cache implementation to use for this handler

Method Details

progressUpdate

public void progressUpdate(long value)

Description copied from interface: ReadProgressListener

Notification of where the stream is at. The value is dependent on the type, absolute or relative.

Specified by:

progressUpdate in interface ReadProgressListener

Parameters:

value - The new value

streamClosed

public void streamClosed()

Description copied from interface: ReadProgressListener

The stream has closed.

Specified by:

streamClosed in interface ReadProgressListener

processLoadRequest

public void processLoadRequest(org.j3d.util.ErrorReporter reporter,
 String[] urls,
 Vector<LoadDetails> loadList)

Description copied from interface: LoadRequestHandler

Process this load request now.

Specified by:

processLoadRequest in interface LoadRequestHandler

Parameters:

reporter - The errorReporter to send all messages to

urls - The list of URLs to load

loadList - The list of LoadDetails objects to sent the fulfilled requests to

abortCurrentFile

public void abortCurrentFile()

Description copied from interface: LoadRequestHandler

Notification to abort loading the current resource. If there is one loading, it will terminate the procedure immediately and start fetching the next available URI. This will only work if we are currently processing a file. If we are not processing a file then this is ignored.

Specified by:

abortCurrentFile in interface LoadRequestHandler

shutdown

public void shutdown()

Description copied from interface: LoadRequestHandler

Notification to shut down the load process entirely for this thread. It probably means we are about to close down the whole system. If we are held in the queue, blocked waiting for input, the caller should call BlockingQueue.purge() on the queue after calling this method. That will force the block to exit and this thread to end.

Specified by:

shutdown in interface LoadRequestHandler