com.ihr.xbrl.om

Interface XBRLSourceCatalogInterface

All Known Implementing Classes:

XBRLCatalogResourceSource, XBRLCatalogSAXSource, XBRLCatalogStreamSource

public interface XBRLSourceCatalogInterface

A class implementing this interface will be able to provide a local file association to a remote file. the remote file may be embedded in a jar file.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
java.io.File	getLocalFile() Gets the local file.
java.lang.String	getPackageName() Obtains back the package name if it was wet by the package manager.
java.lang.String	getVersion() Obtains the version of this catalog file.
void	setLocalFile(java.io.File f) Sets the local file to the parameter indicated.
void	setPackageName(java.lang.String name) Sets the package name of the Catalog package that contains this file
void	setVersion(java.lang.String version) Allows the package manager to set the package version of this file.

Method Detail

setLocalFile

void setLocalFile(java.io.File f)

Sets the local file to the parameter indicated.

Parameters:

f - a File representing a local file in the filesystem

getLocalFile

java.io.File getLocalFile()

Gets the local file.

Returns:

File

setPackageName

void setPackageName(java.lang.String name)

Sets the package name of the Catalog package that contains this file

Parameters:

name - as String, null if no information exists

getPackageName

java.lang.String getPackageName()

Obtains back the package name if it was wet by the package manager.

Returns:

the package name or null if not set

setVersion

void setVersion(java.lang.String version)

Allows the package manager to set the package version of this file.

Parameters:

version - the string with version information coming from the catalog manager

getVersion

java.lang.String getVersion()

Obtains the version of this catalog file.

Returns:

String information in the package about the package version