org.barrelorgandiscovery.playlist

Class VirtualBookRef

java.lang.Object

org.barrelorgandiscovery.playlist.VirtualBookRef

All Implemented Interfaces:

java.io.Serializable, IVirtualBookRef

public class VirtualBookRef
extends java.lang.Object
implements java.io.Serializable, IVirtualBookRef

Serializable Reference of a virtual book

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VirtualBookRef(java.io.File refFile) Construct a VirtualBookReference, and read the metadata informations

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlias() Get a name for the reference
boolean	isValid() Method for knowning the reference can be opened
VirtualBookXmlIO.VirtualBookResult	open() Open the virtual book, may take time

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualBookRef

public VirtualBookRef(java.io.File refFile)
               throws java.lang.Exception

Construct a VirtualBookReference, and read the metadata informations

Parameters:

refFile - the ref file

Throws:

java.lang.Exception

Method Detail

getAlias

public java.lang.String getAlias()

Description copied from interface: IVirtualBookRef

Get a name for the reference

Specified by:

getAlias in interface IVirtualBookRef

Returns:

isValid

public boolean isValid()

Description copied from interface: IVirtualBookRef

Method for knowning the reference can be opened

Specified by:

isValid in interface IVirtualBookRef

Returns:

open

public VirtualBookXmlIO.VirtualBookResult open()
                                        throws java.lang.Exception

Description copied from interface: IVirtualBookRef

Open the virtual book, may take time

Specified by:

open in interface IVirtualBookRef

Returns:

Throws:

java.lang.Exception