org.hl7.fhir.utilities.cache

Class NpmPackage

java.lang.Object

org.hl7.fhir.utilities.cache.NpmPackage

public class NpmPackage
extends Object

info and loader for a package Packages may exist on disk in the cache, or purely in memory when they are loaded on the fly Packages are contained in subfolders (see the package spec). The FHIR resources will be in "package"

Author:

Grahame Grieve

Constructor Summary

Constructors

Constructor and Description
NpmPackage(com.google.gson.JsonObject npm, Map<String,byte[]> content, List<String> folders)
NpmPackage(String path)

Method Summary

Modifier and Type	Method and Description
String	canonical()
List<String>	copyTo(String folder, String dest) Copies all the files in the package folder [folder] to the nominated dest, and returns a list of all the file names copied
String	description()
String	fhirVersion() convenience method for getting the package fhir version
static NpmPackage	fromZip(InputStream stream, boolean dropRootFolder)
IniFile	getCache()
com.google.gson.JsonObject	getNpm() Handle to the package json file
String	getPath()
String	getWebLocation()
boolean	isType(PackageGenerator.PackageType template)
List<String>	list(String folder) Accessing the contents of the package - get a list of files in a subfolder of the package
InputStream	load(String folder, String file) get a stream that contains the contents of one of the files in a folder
String	name() convenience method for getting the package name
void	setPath(String path) only for use by the package manager itself
String	type()
String	version() convenience method for getting the package version

Methods inherited from class java.lang.Object

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

Constructor Detail

NpmPackage

public NpmPackage(com.google.gson.JsonObject npm,
                  Map<String,byte[]> content,
                  List<String> folders)

NpmPackage

public NpmPackage(String path)
           throws IOException

Throws:

IOException

Method Detail

fromZip

public static NpmPackage fromZip(InputStream stream,
                                 boolean dropRootFolder)
                          throws IOException

Throws:

IOException

list

public List<String> list(String folder)
                  throws IOException

Accessing the contents of the package - get a list of files in a subfolder of the package

Parameters:

folder -

Returns:

Throws:

IOException

copyTo

public List<String> copyTo(String folder,
                           String dest)
                    throws IOException

Copies all the files in the package folder [folder] to the nominated dest, and returns a list of all the file names copied

Parameters:

folder -

Returns:

Throws:

IOException

load

public InputStream load(String folder,
                        String file)
                 throws IOException

get a stream that contains the contents of one of the files in a folder

Parameters:

folder -

file -

Returns:

Throws:

IOException

getNpm

public com.google.gson.JsonObject getNpm()

Handle to the package json file

Returns:

name

public String name()

convenience method for getting the package name

Returns:

canonical

public String canonical()

version

public String version()

convenience method for getting the package version

Returns:

fhirVersion

public String fhirVersion()

convenience method for getting the package fhir version

Returns:

description

public String description()

isType

public boolean isType(PackageGenerator.PackageType template)

type

public String type()

getPath

public String getPath()

getCache

public IniFile getCache()

setPath

public void setPath(String path)

only for use by the package manager itself

Parameters:

path -

getWebLocation

public String getWebLocation()