org.jibx.util

Class HolderBase

java.lang.Object

org.jibx.util.HolderBase

public abstract class HolderBase
extends Object

Base class for external data used in constructing a namespaced file which may reference other files of the same type. This class tracks both the referenced files and the corresponding namespace references, assigning prefixes for the latter as appropriate. The namespace associated with this file is always given the prefix 'tns', while those used for other files get prefixes of the form 'ns1', 'ns2', etc.

Author:

Dennis M. Sosnoski

Constructor Summary

Constructors

Constructor and Description
HolderBase(String uri) Constructor for a file being generated.
HolderBase(String uri, String name) Constructor for an existing file.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addNamespaceDecl(String prefix, String uri) Subclass hook method to handle adding a namespace declaration.
void	addReference(HolderBase ref) Record a reference from this file to another file of the same type.
void	finish() Implementation method for subclasses to complete the construction of the file.
String	getFileName() Get the file name to be used for this file.
String	getNamespace() Get namespace URI associated with this file.
String	getPrefix(String uri) Get the prefix for a namespace URI.
Set	getReferences() Get the set of references from this file to other files of the same type.
boolean	isExistingFile() Check if file already exists.
boolean	isModifiable() Check if file is modifiable.
void	setFileName(String name) Set the file name to be used for this file.

Methods inherited from class java.lang.Object

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

Constructor Detail

HolderBase

public HolderBase(String uri)

Constructor for a file being generated.

Parameters:

uri - (null if no-namespace binding)

HolderBase

public HolderBase(String uri,
                  String name)

Constructor for an existing file.

Parameters:

uri - (null if no-namespace binding)

name - file name

Method Detail

isExistingFile

public boolean isExistingFile()

Check if file already exists.

Returns:

true if existing file, false if not

isModifiable

public boolean isModifiable()

Check if file is modifiable. This will always be false for an existing file, and will be set false for new files when finish() is called.

Returns:

true if file is modifiable, false if not

getPrefix

public String getPrefix(String uri)

Get the prefix for a namespace URI. The first time this is called for a particular namespace URI a prefix is assigned and returned. This assumes that the default namespace is always the no-namespace.

Parameters:

uri - URI

Returns:

prefix

addNamespaceDecl

protected abstract void addNamespaceDecl(String prefix,
                                         String uri)

Subclass hook method to handle adding a namespace declaration. The implementation of this method needs to set up the namespace declaration for output in the generated XML.

Parameters:

prefix - Prefix

uri - URI

getNamespace

public String getNamespace()

Get namespace URI associated with this file.

Returns:

namespace (null if no-namespace)

getFileName

public String getFileName()

Get the file name to be used for this file.

Returns:

name (null if not set)

setFileName

public void setFileName(String name)

Set the file name to be used for this file.

Parameters:

name - Fielname

addReference

public void addReference(HolderBase ref)

Record a reference from this file to another file of the same type. This adds the reference to the set of references. Self-references are ignored.

Parameters:

ref - to file

getReferences

public Set getReferences()

Get the set of references from this file to other files of the same type.

Returns:

references

finish

public void finish()

Implementation method for subclasses to complete the construction of the file. This includes processing references to other files, as well as any other components of the file which need to be finalized. This method must be called after all references have been added, allowing the subclass to add any necessary structures to the file representation. Subclasses must call the base class implementation when their processing is completed.