Package 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	NpmPackage.NpmPackageFolder

Method Summary

Modifier and Type	Method	Description
String	canonical()
String	date()
void	debugDump(String purpose)
List<String>	dependencies()
String	dependencySummary()
String	description()
String	fhirVersion()	convenience method for getting the package fhir version
String	fhirVersionList()
static NpmPackage	fromFolder(String path)
static NpmPackage	fromFolder(String folder, PackageGenerator.PackageType defType, String... exemptions)
static NpmPackage	fromPackage(InputStream tgz)
static NpmPackage	fromPackage(InputStream tgz, String desc)
static NpmPackage	fromPackage(InputStream tgz, String desc, boolean progress)
static NpmPackage	fromZip(InputStream stream, boolean dropRootFolder, String desc)
Map<String,NpmPackage.NpmPackageFolder>	getFolders()	special case when playing around inside the package
com.google.gson.JsonObject	getNpm()	Handle to the package json file
String	getPath()
Map<String,List<String>>	getTypes()
String	getWebLocation()
boolean	hasFile(String folder, String file)
String	homepage()
boolean	isType(PackageGenerator.PackageType template)
static boolean	isValidName(String pid)
static boolean	isValidVersion(String ver)
String	license()
List<String>	list(String folder)	Accessing the contents of the package - get a list of files in a subfolder of the package
List<String>	listResources(String... types)
InputStream	load(String folder, String file)	get a stream that contains the contents of one of the files in a folder
InputStream	loadExampleResource(String type, String id)
void	loadFile(String n, byte[] data)
static void	loadFiles(NpmPackage res, String path, File source, String... exemptions)
InputStream	loadResource(String file)	use the name from listResources()
InputStream	loadResource(String type, String id)
String	name()	convenience method for getting the package name
void	readStream(InputStream tgz, String desc, boolean progress)
void	save(OutputStream stream)
String	summary()
String	title()
String	toolsVersion()
String	type()
void	unPack(String dir)
void	unPack(String dir, boolean withAppend)
void	unPackWithAppend(String dir)
String	url()
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

Method Detail

isValidName

public static boolean isValidName(String pid)

isValidVersion

public static boolean isValidVersion(String ver)

fromFolder

public static NpmPackage fromFolder(String path)
                             throws IOException

Throws:

IOException

loadFiles

public static void loadFiles(NpmPackage res,
                             String path,
                             File source,
                             String... exemptions)
                      throws FileNotFoundException,
                             IOException

Throws:

FileNotFoundException

IOException

fromFolder

public static NpmPackage fromFolder(String folder,
                                    PackageGenerator.PackageType defType,
                                    String... exemptions)
                             throws IOException

Throws:

IOException

fromPackage

public static NpmPackage fromPackage(InputStream tgz)
                              throws IOException

Throws:

IOException

fromPackage

public static NpmPackage fromPackage(InputStream tgz,
                                     String desc)
                              throws IOException

Throws:

IOException

fromPackage

public static NpmPackage fromPackage(InputStream tgz,
                                     String desc,
                                     boolean progress)
                              throws IOException

Throws:

IOException

readStream

public void readStream(InputStream tgz,
                       String desc,
                       boolean progress)
                throws IOException

Throws:

IOException

loadFile

public void loadFile(String n,
                     byte[] data)
              throws IOException

Throws:

IOException

fromZip

public static NpmPackage fromZip(InputStream stream,
                                 boolean dropRootFolder,
                                 String desc)
                          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

listResources

public List<String> listResources(String... types)
                           throws IOException

Throws:

IOException

loadResource

public InputStream loadResource(String file)
                         throws IOException

use the name from listResources()

Parameters:

id -

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

hasFile

public boolean hasFile(String folder,
                       String file)
                throws IOException

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:

date

public String date()

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:

summary

public String summary()

isType

public boolean isType(PackageGenerator.PackageType template)

type

public String type()

description

public String description()

getPath

public String getPath()

dependencies

public List<String> dependencies()

homepage

public String homepage()

url

public String url()

title

public String title()

toolsVersion

public String toolsVersion()

license

public String license()

getWebLocation

public String getWebLocation()

loadResource

public InputStream loadResource(String type,
                                String id)
                         throws IOException

Throws:

IOException

loadExampleResource

public InputStream loadExampleResource(String type,
                                       String id)
                                throws IOException

Throws:

IOException

getFolders

public Map<String,NpmPackage.NpmPackageFolder> getFolders()

special case when playing around inside the package

save

public void save(OutputStream stream)
          throws IOException

Throws:

IOException

getTypes

public Map<String,List<String>> getTypes()

fhirVersionList

public String fhirVersionList()

dependencySummary

public String dependencySummary()

unPack

public void unPack(String dir)
            throws IOException

Throws:

IOException

unPackWithAppend

public void unPackWithAppend(String dir)
                      throws IOException

Throws:

IOException

unPack

public void unPack(String dir,
                   boolean withAppend)
            throws IOException

Throws:

IOException

debugDump

public void debugDump(String purpose)