Package org.javarosa.core.reference

Class PrefixedRootFactory

java.lang.Object

org.javarosa.core.reference.PrefixedRootFactory

All Implemented Interfaces:

ReferenceFactory

Direct Known Subclasses:

ResourceReferenceFactory

public abstract class PrefixedRootFactory
extends Object
implements ReferenceFactory

PrefixedRootFactory provides a clean way to implement the vast majority of behavior for a reference factory.

A PrefixedRootFactory defines a set of roots which it can provide references for. Roots can either be a full URI root like "http://", or "file://", or can be local roots like "resource" or "file", in which case the assumed protocol parent will be "jr://".

For example: a PrefixedRootFactory with the roots "media" and "resource" will be used by the ReferenceManager to derive any URI with the roots

• jr://media/
• jr://resource/

like

jr://media/checkmark.png

and a PrefixedRootFactory with roots "file" and "file://" will be used by the ReferenceManager to derive any URI with the roots

• jr://file/
• file://

like

jr://file/myxform.xhtml

or

file://myxform.xhtml

Author:

ctsims

Constructor Summary

Constructors

Constructor	Description
PrefixedRootFactory(String[] roots)	Construct a PrefixedRootFactory which handles the roots provided.

Method Summary

Modifier and Type	Method	Description
Reference	derive(String URI)
Reference	derive(String URI, String context)
boolean	derives(String URI)
protected abstract Reference	factory(String terminal, String URI)	Creates a Reference using the most locally available part of a URI.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PrefixedRootFactory

public PrefixedRootFactory(String[] roots)

Construct a PrefixedRootFactory which handles the roots provided. Implementing subclasses will actually do the root construction by implementing the "factory()" method.

Parameters:

roots - The roots of URI's which should be derived by this factory.

Method Details

derive

public Reference derive(String URI) throws InvalidReferenceException

Specified by:

derive in interface ReferenceFactory

Throws:

InvalidReferenceException

factory

protected abstract Reference factory(String terminal, String URI)

Creates a Reference using the most locally available part of a URI.

Parameters:

terminal - The local part of the URI for this prefixed root (excluding the root itself)

URI - The full URI

Returns:

A reference which describes the URI

derive

public Reference derive(String URI, String context) throws InvalidReferenceException

Specified by:

derive in interface ReferenceFactory

Throws:

InvalidReferenceException

derives

public boolean derives(String URI)

Specified by:

derives in interface ReferenceFactory

toString

public String toString()

Overrides:

toString in class Object