Package org.hl7.fhir.utilities.npm

Class NpmPackage

java.lang.Object

org.hl7.fhir.utilities.npm.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.IndexVersionSorter
static interface	NpmPackage.ITransformingLoader
class	NpmPackage.NpmPackageFolder
class	NpmPackage.PackageResourceInformation
class	NpmPackage.PackageResourceInformationSorter

Method Summary

Modifier and Type	Method	Description
void	addFile(String folderName, String name, byte[] cnt, String type)
boolean	canLazyLoad()
String	canonical()
void	clearFolder(String folderName)
String	date()
Date	dateAsDate()
void	debugDump(String purpose)
void	deleteFolder(String folderName)
List<String>	dependencies()
String	dependencySummary()
String	description()
static NpmPackage	empty()	Factory method that starts a new empty package using the given PackageGenerator to create the manifest
static NpmPackage	empty(PackageGenerator thePackageGenerator)	Factory method that starts a new empty package using the given PackageGenerator to create the manifest
String	fhirVersion()	convenience method for getting the package fhir version
String	fhirVersionList()
static NpmPackage	fromFolder(String path)	Factory method that parses a package from an extracted folder
static NpmPackage	fromFolder(String folder, PackageGenerator.PackageType defType, String... exemptions)
static @NotNull NpmPackage	fromPackage(InputStream tgz)
static NpmPackage	fromPackage(InputStream tgz, String desc)
static NpmPackage	fromPackage(InputStream tgz, String desc, boolean progress)
static NpmPackage	fromUrl(String source)
static NpmPackage	fromZip(InputStream stream, boolean dropRootFolder, String desc)
Map<String,NpmPackage.NpmPackageFolder>	getFolders()	special case when playing around inside the package
JsonObject	getNpm()	Handle to the package json file
String	getPath()
Map<String,List<String>>	getTypes()	Keys are resource type names, values are filenames
Map<String,Object>	getUserData()
String	getWebLocation()
boolean	hasCanonical(String url)
boolean	hasFile(String folder, String file)
String	homepage()
String	id()	convenience method for getting the package id (which in NPM language is the same as the name)
void	indexFolder(String desc, NpmPackage.NpmPackageFolder folder)
boolean	isChangedByLoader()
boolean	isCore()
static boolean	isInternalExemptFile(File f)
boolean	isNotForPublication()
boolean	isTx()
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<NpmPackage.PackageResourceInformation>	listIndexedResources(String... types)
List<String>	listResources(String... types)
InputStream	load(String file)	get a stream that contains the contents of one of the files in the base package
InputStream	load(String folder, String file)	get a stream that contains the contents of one of the files in a folder
InputStream	load(NpmPackage.PackageResourceInformation p)
void	loadAllFiles()
void	loadAllFiles(NpmPackage.ITransformingLoader loader)
InputStream	loadByCanonical(String canonical)	get a stream that contains the contents of a resource in the base folder, by it's canonical URL
InputStream	loadByCanonical(String folder, String canonical)	get a stream that contains the contents of a resource in the nominated folder, by it's canonical URL
InputStream	loadByCanonicalVersion(String canonical, String version)	get a stream that contains the contents of a resource in the base folder, by it's canonical URL
InputStream	loadByCanonicalVersion(String folder, String canonical, String version)	get a stream that contains the contents of a resource in the nominated folder, by it's canonical URL
InputStream	loadExampleResource(String type, String id)
void	loadFile(String n, byte[] data)
void	loadFiles(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(File directory)
void	save(OutputStream stream)
String	summary()
String	title()
String	toolsVersion()
String	toString()
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, 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

Factory method that parses a package from an extracted folder

Throws:

IOException

empty

public static NpmPackage empty(PackageGenerator thePackageGenerator)

Factory method that starts a new empty package using the given PackageGenerator to create the manifest

empty

public static NpmPackage empty()

Factory method that starts a new empty package using the given PackageGenerator to create the manifest

getUserData

public Map<String,Object> getUserData()

loadFiles

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

Throws:

FileNotFoundException

IOException

isInternalExemptFile

public static boolean isInternalExemptFile(File f)

fromFolder

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

Throws:

IOException

fromPackage

@NotNull
public static @NotNull 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

indexFolder

public void indexFolder(String desc,
                        NpmPackage.NpmPackageFolder folder)
                 throws FileNotFoundException,
                        IOException

Throws:

FileNotFoundException

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

listIndexedResources

public List<NpmPackage.PackageResourceInformation> listIndexedResources(String... types)
                                                                 throws IOException

Throws:

IOException

loadResource

public InputStream loadResource(String file)
                         throws IOException

use the name from listResources()

Parameters:

id -

Returns:

Throws:

IOException

loadByCanonical

public InputStream loadByCanonical(String canonical)
                            throws IOException

get a stream that contains the contents of a resource in the base folder, by it's canonical URL

Parameters:

url - - the canonical URL of the resource (exact match only)

Returns:

null if it is not found

Throws:

IOException

loadByCanonical

public InputStream loadByCanonical(String folder,
                                   String canonical)
                            throws IOException

get a stream that contains the contents of a resource in the nominated folder, by it's canonical URL

Parameters:

folder - - one of the folders in the package (main folder is "package")

url - - the canonical URL of the resource (exact match only)

Returns:

null if it is not found

Throws:

IOException

loadByCanonicalVersion

public InputStream loadByCanonicalVersion(String canonical,
                                          String version)
                                   throws IOException

get a stream that contains the contents of a resource in the base folder, by it's canonical URL

Parameters:

url - - the canonical URL of the resource (exact match only)

version - - the specified version (or null if the most recent)

Returns:

null if it is not found

Throws:

IOException

loadByCanonicalVersion

public InputStream loadByCanonicalVersion(String folder,
                                          String canonical,
                                          String version)
                                   throws IOException

get a stream that contains the contents of a resource in the nominated folder, by it's canonical URL

Parameters:

folder - - one of the folders in the package (main folder is "package")

url - - the canonical URL of the resource (exact match only)

version - - the specified version (or null if the most recent)

Returns:

null if it is not found

Throws:

IOException

load

public InputStream load(String file)
                 throws IOException

get a stream that contains the contents of one of the files in the base package

Parameters:

file -

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 JsonObject getNpm()

Handle to the package json file

Returns:

name

public String name()

convenience method for getting the package name

Returns:

id

public String id()

convenience method for getting the package id (which in NPM language is the same as the 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(File directory)
          throws IOException

Throws:

IOException

save

public void save(OutputStream stream)
          throws IOException

Throws:

IOException

getTypes

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

Keys are resource type names, values are filenames

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)

clearFolder

public void clearFolder(String folderName)

deleteFolder

public void deleteFolder(String folderName)

addFile

public void addFile(String folderName,
                    String name,
                    byte[] cnt,
                    String type)

loadAllFiles

public void loadAllFiles()
                  throws IOException

Throws:

IOException

loadAllFiles

public void loadAllFiles(NpmPackage.ITransformingLoader loader)
                  throws IOException

Throws:

IOException

isChangedByLoader

public boolean isChangedByLoader()

isCore

public boolean isCore()

isTx

public boolean isTx()

hasCanonical

public boolean hasCanonical(String url)

canLazyLoad

public boolean canLazyLoad()
                    throws IOException

Throws:

IOException

isNotForPublication

public boolean isNotForPublication()

load

public InputStream load(NpmPackage.PackageResourceInformation p)
                 throws FileNotFoundException

Throws:

FileNotFoundException

dateAsDate

public Date dateAsDate()

fromUrl

public static NpmPackage fromUrl(String source)
                          throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object