ObjectStore (org.jpedal:OpenViewerFX 7.12.28 API)

java.lang.Object
- org.jpedal.io.ObjectStore

```
public class ObjectStore
extends Object
```
set of methods to save/load objects to keep memory usage to a minimum by spooling images to disk Also includes ancillary method to store a filename - LogWriter is my logging class - Several methods are very similar and I should recode my code to use a common method for the RGB conversion

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`fullFileName`
`static Integer`	`IMAGE_COLORSPACE` paramter stored on cached images
`static Integer`	`IMAGE_DEPTH` paramter stored on cached images
`static Integer`	`IMAGE_HEIGHT` parameter stored on cached images
`static Integer`	`IMAGE_MASKCOL` paramter stored on cached images
`static Integer`	`IMAGE_pX` parameter stored on cached images
`static Integer`	`IMAGE_pY` parameter stored on cached images
`static Integer`	`IMAGE_WIDTH` parameter stored on cached images
`static boolean`	`isMultiThreaded` do not set unless you know what you are doing
`static String`	`multiThreaded_root_dir`
`static String`	`temp_dir` temp storage for the images so they are not held in memory
`static long`	`time` period after which we assumes files must be dead (ie from crashed instance) default is four hour image time

Constructor Summary

Constructors
Constructor and Description
`ObjectStore()` ObjectStore - Converted for Threading purposes - To fix any errors please try replacing ObjectStore with {your instance of PdfDecoder}.getObjectStore() -

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`cachePageAsBytes(String key, byte[] bytes)`
`static void`	`copy(InputStream from, OutputStream to)`
`static void`	`copy(String source, String destination)` Save Copy.
`static void`	`copyCMYKimages(String target_dir)` copies cmyk raw data from cmyk temp dir to target directory.
`static File`	`createTempFile(String filename)`
`protected void`	`finalize()`
`void`	`flush()` routine to remove all objects from temp store
`static void`	`flushPages()` delete all cached pages
`static byte[]`	`getCachedPageAsBytes(String key)`
`String`	`getCurrentFilename()` Get the file name - we use this as a get in our file repository -
`String`	`getCurrentFilepath()` Get the file path for current PDF
`String`	`getFileForCachedImage(String current_image)`
`String`	`getKey()`
`byte[]`	`getRawImageData(String i)` Retrieve byte data on disk.
`Object`	`getRawImageDataParameter(String imageID, Integer key)` Return parameter stored for image or null.
`void`	`init(String current_key)` init method to pass in values for temp directory, unique key, etc so program knows where to store files.
`boolean`	`isRawImageDataSaved(String number)` see if image data saved.
`BufferedImage`	`loadStoredImage(String current_image)` load a image when required and remove from store
`static String`	`removeIllegalFileNameCharacters(String s)` Remove troublesome characters from temp file names.
`void`	`saveAsCopy(String current_image, String destination)` Save a Copy.
`void`	`saveRawImageData(String pageImgCount, byte[] bytes, int w, int h, int bpc, int pX, int pY, byte[] maskCol, int colorSpaceID)`
`boolean`	`saveStoredImage(String current_image, BufferedImage image, boolean file_name_is_path, String type)` save buffered image as JPEG or tif
`boolean`	`saveStoredImageAsBytes(String currentImage, BufferedImage image, boolean file_name_is_path)`
`void`	`setEncHash(byte[] pass)`
`void`	`setFileToDeleteOnFlush(String rawFileName)` Add file to list we delete on flush so we can clear any temp files we create.
`void`	`storeFileName(String name)` store filename as a key we can use to differentiate images,etc - Note this method is not part of the API and is not guaranteed to be in future versions of JPedal -

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- isMultiThreaded
```
public static boolean isMultiThreaded
```
  do not set unless you know what you are doing
- temp_dir
```
public static String temp_dir
```
  temp storage for the images so they are not held in memory
- multiThreaded_root_dir
```
public static final String multiThreaded_root_dir
```
- IMAGE_WIDTH
```
public static final Integer IMAGE_WIDTH
```
  parameter stored on cached images
- IMAGE_HEIGHT
```
public static final Integer IMAGE_HEIGHT
```
  parameter stored on cached images
- IMAGE_pX
```
public static final Integer IMAGE_pX
```
  parameter stored on cached images
- IMAGE_pY
```
public static final Integer IMAGE_pY
```
  parameter stored on cached images
- IMAGE_MASKCOL
```
public static final Integer IMAGE_MASKCOL
```
  paramter stored on cached images
- IMAGE_COLORSPACE
```
public static final Integer IMAGE_COLORSPACE
```
  paramter stored on cached images
- IMAGE_DEPTH
```
public static final Integer IMAGE_DEPTH
```
  paramter stored on cached images
- time
```
public static final long time
```
  period after which we assumes files must be dead (ie from crashed instance) default is four hour image time
  
  See Also:
  
  Constant Field Values
- fullFileName
```
public String fullFileName
```

Constructor Detail
- ObjectStore
```
public ObjectStore()
```
  ObjectStore - Converted for Threading purposes - To fix any errors please try replacing ObjectStore with {your instance of PdfDecoder}.getObjectStore() -

Method Detail

getCurrentFilename
```
public String getCurrentFilename()
```
Get the file name - we use this as a get in our file repository -
Note this method is not part of the API and is not guaranteed to be in future versions of JPedal -

Returns:

String

getCurrentFilepath
```
public String getCurrentFilepath()
```
Get the file path for current PDF
Note this method is not part of the API and is not guaranteed to be in future versions of JPedal -

Returns:

String

storeFileName
```
public final void storeFileName(String name)
```
store filename as a key we can use to differentiate images,etc - Note this method is not part of the API and is not guaranteed to be in future versions of JPedal -

Parameters:

name - is of type String

saveStoredImageAsBytes

public final boolean saveStoredImageAsBytes(String currentImage,
                                            BufferedImage image,
                                            boolean file_name_is_path)

saveStoredImage

public final boolean saveStoredImage(String current_image,
                                     BufferedImage image,
                                     boolean file_name_is_path,
                                     String type)

save buffered image as JPEG or tif

Parameters:: current_image - is of type String; image - is of type BufferedImage; file_name_is_path - is of type boolean; type - is of type String
Returns:: boolean

init
```
public final void init(String current_key)
```
init method to pass in values for temp directory, unique key, etc so program knows where to store files.

Parameters:

current_key - is of type String

loadStoredImage
```
public final BufferedImage loadStoredImage(String current_image)
```
load a image when required and remove from store

Parameters:

current_image - is of type String

Returns:

BufferedImage

flush
```
public final void flush()
```
routine to remove all objects from temp store

copyCMYKimages
```
public static void copyCMYKimages(String target_dir)
```
copies cmyk raw data from cmyk temp dir to target directory.

Parameters:

target_dir - is of type String

getFileForCachedImage

public String getFileForCachedImage(String current_image)

saveAsCopy

public final void saveAsCopy(String current_image,
                             String destination)

Save a Copy.

Parameters:: current_image - is of type String; destination - is of type String

copy

public static void copy(String source,
                        String destination)

Save Copy.

Parameters:: source - is of type String.; destination - is of type String.

copy

public static void copy(InputStream from,
                        OutputStream to)

flushPages
```
public static void flushPages()
```
delete all cached pages

finalize
```
protected void finalize()
```
Overrides:

finalize in class Object

getCachedPageAsBytes

public static byte[] getCachedPageAsBytes(String key)

cachePageAsBytes

public static void cachePageAsBytes(String key,
                                    byte[] bytes)

saveRawImageData

public void saveRawImageData(String pageImgCount,
                             byte[] bytes,
                             int w,
                             int h,
                             int bpc,
                             int pX,
                             int pY,
                             byte[] maskCol,
                             int colorSpaceID)

isRawImageDataSaved
```
public boolean isRawImageDataSaved(String number)
```
see if image data saved.

Parameters:

number - is of type String

Returns:

boolean

getRawImageData
```
public byte[] getRawImageData(String i)
```
Retrieve byte data on disk.

Parameters:

i - is of type String

Returns:

byte[]

getRawImageDataParameter

public Object getRawImageDataParameter(String imageID,
                                       Integer key)

Return parameter stored for image or null.

Parameters:: imageID - is of type String; key - is of type Integer
Returns:: Object

createTempFile

public static File createTempFile(String filename)
                           throws IOException

Throws:: IOException

removeIllegalFileNameCharacters
```
public static String removeIllegalFileNameCharacters(String s)
```
Remove troublesome characters from temp file names.

Parameters:

s - is of type String

Returns:

String

setFileToDeleteOnFlush
```
public void setFileToDeleteOnFlush(String rawFileName)
```
Add file to list we delete on flush so we can clear any temp files we create.

Parameters:

rawFileName - is of type String

getKey
```
public String getKey()
```

setEncHash
```
public void setEncHash(byte[] pass)
```

Class ObjectStore

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

isMultiThreaded

temp_dir

multiThreaded_root_dir

IMAGE_WIDTH

IMAGE_HEIGHT

IMAGE_pX

IMAGE_pY

IMAGE_MASKCOL

IMAGE_COLORSPACE

IMAGE_DEPTH

time

fullFileName

Constructor Detail

ObjectStore

Method Detail

getCurrentFilename

getCurrentFilepath

storeFileName

saveStoredImageAsBytes

saveStoredImage

init

loadStoredImage

flush

copyCMYKimages

getFileForCachedImage

saveAsCopy

copy

copy

flushPages

finalize

getCachedPageAsBytes

cachePageAsBytes

saveRawImageData

isRawImageDataSaved

getRawImageData

getRawImageDataParameter

createTempFile

removeIllegalFileNameCharacters

setFileToDeleteOnFlush

getKey

setEncHash