org.icepdf.core.pobjects.actions

Class FileSpecification

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.actions.FileSpecification

public class FileSpecification
extends Dictionary

The File Specification diction provides more flexibility then the string form. allowing different files to be specified for different file systems or platforms, or for file system othere than the standard ones (DOS/Windows, Mac OS, and Unix).

Since:

2.6

Author:

ICEsoft Technologies, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static Name	CI_KEY A collection item dictionary, which shall be used to create the user interface for portable collections (see 7.11.6, "Collection Items").
static Name	DESC_KEY Descriptive text associated with the file specification.
static Name	DOS_KEY A file specification string (see 7.11.2, "File Specification Strings") representing a DOS file name.
static Name	EF_KEY (Required if RF is present; PDF 1.3; amended to include the UF key in PDF 1.7) A dictionary containing a subset of the keys F, UF, DOS, Mac, and Unix, corresponding to the entries by those names in the file specification dictionary.
static Name	F_KEY (Required if the DOS, Mac, and Unix entries are all absent; amended with the UF entry for PDF 1.7) A file specification string of the form described in 7.11.2, "File Specification Strings," or (if the file system is URL) a uniform resource locator, as described in 7.11.5, "URL Specifications." The UF entry should be used in addition to the F entry.
static Name	FS_KEY The name of the file system that shall be used to interpret this file specification.
static Name	ID_KEY An array of two byte strings constituting a file identifier that should be included in the referenced file.
static Name	MAC_KEY A file specification string (see 7.11.2, "File Specification Strings") representing a Mac OS file name.
static Name	RF_KEY A dictionary with the same structure as the EF dictionary, which shall be present.
static Name	UF_KEY A Unicode text string that provides file specification of the form described in 7.11.2, "File Specification Strings." This is a text string encoded using PDFDocEncoding or UTF-16BE with a leading byte-order marker (as defined in 7.9.2.2, "Text String Type").
static Name	UNIX_KEY A file specification string (see 7.11.2, "File Specification Strings") representing a UNIX file name.
static Name	V_KEY flag indicating whether the file referenced by the file specification is volatile (changes frequently with time).

Fields inherited from class org.icepdf.core.pobjects.Dictionary

entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
FileSpecification(Library l, java.util.HashMap h) Constructs a new specification dictionary.

Method Summary

Modifier and Type	Method and Description
java.util.HashMap	getCollectionItemDictionary() GA collection item dictionary, which shall be used to create the user interface for portable collections (see 7.11.6, "Collection Items").
java.lang.String	getDescription() Gets the descriptive text associated with the file specification.
java.lang.String	getDos() Gets the file specification string representing a DOS file name.
java.util.HashMap	getEmbeddedFileDictionary() Gets a dictionary containing a subset of the keys F, DOS, Mac, and Unix.
java.lang.String	getFileSpecification() Gets the file specification string.
Name	getFileSystemName() Gets the name of the file system to be used to interpret this file specification.
java.lang.String	getId() Gets an array of two strings constituting a file identifier that is also included in the referenced file.
java.lang.String	getMac() Gets the file specification string representing a Mac file name.
java.util.HashMap	getRelatedFilesDictionary() Gets a dictionary with the same structure as the EF dectionary, which must also b present.
Name	getType() The type of the PDF object that this dictionary describes which is always "Filespec".
java.lang.String	getUnicodeFileSpecification() Gets the unicode file specification string.
java.lang.String	getUnix() Gets the file specification string representing a Unix file name.
java.lang.Boolean	isVolitile() Returns a flag indicating whether the file referenced by the file specification is volatile (changes frequently with time).

Methods inherited from class org.icepdf.core.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toString

Methods inherited from class java.lang.Object

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

Field Detail

FS_KEY

public static final Name FS_KEY

The name of the file system that shall be used to interpret this file specification. If this entry is present, all other entries in the dictionary shall be interpreted by the designated file system. PDF shall define only one standard file system name, URL; an application can register other names. This entry shall be independent of the F, UF, DOS, Mac, and Unix entries.

F_KEY

public static final Name F_KEY

(Required if the DOS, Mac, and Unix entries are all absent; amended with the UF entry for PDF 1.7) A file specification string of the form described in 7.11.2, "File Specification Strings," or (if the file system is URL) a uniform resource locator, as described in 7.11.5, "URL Specifications."

The UF entry should be used in addition to the F entry. The UF entry provides cross-platform and cross-language compatibility and the F entry provides backwards compatibility.

UF_KEY

public static final Name UF_KEY

A Unicode text string that provides file specification of the form described in 7.11.2, "File Specification Strings." This is a text string encoded using PDFDocEncoding or UTF-16BE with a leading byte-order marker (as defined in 7.9.2.2, "Text String Type"). The F entry should be included along with this entry for backwards compatibility reasons.

DOS_KEY

public static final Name DOS_KEY

A file specification string (see 7.11.2, "File Specification Strings") representing a DOS file name.

This entry is obsolescent and should not be used by conforming writers.

MAC_KEY

public static final Name MAC_KEY

A file specification string (see 7.11.2, "File Specification Strings") representing a Mac OS file name.

This entry is obsolescent and should not be used by conforming writers.

UNIX_KEY

public static final Name UNIX_KEY

A file specification string (see 7.11.2, "File Specification Strings") representing a UNIX file name.

This entry is obsolescent and should not be used by conforming writers.

ID_KEY

public static final Name ID_KEY

An array of two byte strings constituting a file identifier that should be included in the referenced file.

NOTE The use of this entry improves an application's chances of finding the intended file and allows it to warn the user if the file has changed since the link was made.

V_KEY

public static final Name V_KEY

flag indicating whether the file referenced by the file specification is volatile (changes frequently with time). If the value is true, applications shall not cache a copy of the file. For example, a movie annotation referencing a URL to a live video camera could set this flag to true to notify the conforming reader that it should re-acquire the movie each time it is played. Default value: false.

EF_KEY

public static final Name EF_KEY

(Required if RF is present; PDF 1.3; amended to include the UF key in PDF 1.7) A dictionary containing a subset of the keys F, UF, DOS, Mac, and Unix, corresponding to the entries by those names in the file specification dictionary. The value of each such key shall be an embedded file stream (see 7.11.4, "Embedded File Streams") containing the corresponding file. If this entry is present, the Type entry is required and the file specification dictionary shall be indirectly referenced.

The F and UF entries should be used in place of the DOS, Mac, or Unix entries.

RF_KEY

public static final Name RF_KEY

A dictionary with the same structure as the EF dictionary, which shall be present. Each key in the RF dictionary shall also be present in the EF dictionary. Each value shall be a related files array (see 7.11.4.2, "Related Files Arrays") identifying files that are related to the corresponding file in the EF dictionary. If this entry is present, the Type entry is required and the file specification dictionary shall be indirectly referenced.

DESC_KEY

public static final Name DESC_KEY

Descriptive text associated with the file specification. It shall be used for files in the EmbeddedFiles name tree

CI_KEY

public static final Name CI_KEY

A collection item dictionary, which shall be used to create the user interface for portable collections (see 7.11.6, "Collection Items").

Constructor Detail

FileSpecification

public FileSpecification(Library l,
                         java.util.HashMap h)

Constructs a new specification dictionary.

Parameters:

l - document library.

h - dictionary entries.

Method Detail

getType

public Name getType()

The type of the PDF object that this dictionary describes which is always "Filespec".

Returns:

type of PDF object, "Filespec".

getFileSystemName

public Name getFileSystemName()

Gets the name of the file system to be used to interpret this file specification. This entry is independent of the F, DOS, Mac and Unix entries.

Returns:

the name of the file system to be used to interpret this file.

getFileSpecification

public java.lang.String getFileSpecification()

Gets the file specification string.

Returns:

file specification string.

getUnicodeFileSpecification

public java.lang.String getUnicodeFileSpecification()

Gets the unicode file specification string.

Returns:

file specification string.

getDos

public java.lang.String getDos()

Gets the file specification string representing a DOS file name.

Returns:

DOS file name.

getMac

public java.lang.String getMac()

Gets the file specification string representing a Mac file name.

Returns:

Mac file name.

getUnix

public java.lang.String getUnix()

Gets the file specification string representing a Unix file name.

Returns:

Unix file name.

getId

public java.lang.String getId()

Gets an array of two strings constituting a file identifier that is also included in the referenced file.

Returns:

file identifier.

isVolitile

public java.lang.Boolean isVolitile()

Returns a flag indicating whether the file referenced by the file specification is volatile (changes frequently with time).

Returns:

true indicates the file is volitile and should not be cached, otherwise true.

getEmbeddedFileDictionary

public java.util.HashMap getEmbeddedFileDictionary()

Gets a dictionary containing a subset of the keys F, DOS, Mac, and Unix. The value of each key is an embedded file stream.

Returns:

embbed file stream properties.

getRelatedFilesDictionary

public java.util.HashMap getRelatedFilesDictionary()

Gets a dictionary with the same structure as the EF dectionary, which must also b present. EAch key in the RF dictionary must also be present in the EF diciontary. Each value is a related file array identifying files that a re related to the corresponding file in the EF dictionary.

Returns:

related files dictionary.

getDescription

public java.lang.String getDescription()

Gets the descriptive text associated with the file specification.

Returns:

file identifier.

getCollectionItemDictionary

public java.util.HashMap getCollectionItemDictionary()

GA collection item dictionary, which shall be used to create the user interface for portable collections (see 7.11.6, "Collection Items").

Returns:

related files dictionary.