org.brandao.brcache

Class StreamCache

java.lang.Object

org.brandao.brcache.StreamCache

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BasicCache

public abstract class StreamCache
extends Object
implements Serializable

É a base para um cache. Ele faz o mapeamento chave-fluxo de bytes. Uma chave somente pode estar associado a um fluxo de bytes. Não são permtidos chaves duplicadas.

 ex:
    
    Cache cache = ...;
    InputStream valueStream = ...;
    cache.putStream("uma_chave", valueStream, 1200, 0);
    
 ex2:
    
    InputStream value = cache.getStream("uma_chave");

 

Author:

Brandao

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StreamCache()
StreamCache(long nodeBufferSize, long nodePageSize, double nodeSwapFactor, long indexBufferSize, long indexPageSize, double indexSwapFactor, long dataBufferSize, long dataPageSize, long blockSize, double dataSwapFactor, long maxSizeEntry, int maxSizeKey, Swapper swapper, int quantitySwaperThread, Memory memory) Cria um novo cache.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Remove todas as entradas contidas no cache.
boolean	containsKey(String key) Verifica se uma chave está associada a um valor.
void	destroy() Destrói os dados contidos nesta instância.
protected void	finalize()
long	getCountRead() Obtém a quantidade de itens recuperados.
long	getCountReadData() Obtém a quantidade de bytes recuperados.
long	getCountRemoved() Obtém a quantidade de itens removidos.
long	getCountRemovedData() Obtém a quantidade de bytes removidos.
long	getCountWrite() Obtém a quantidade de itens armazenados.
long	getCountWriteData() Obtém a quantidade de bytes armazenados.
protected InputStream	getStream(String key) Obtém o fluxo de bytes do valor associado à chave.
protected void	init(long nodeBufferSize, long nodePageSize, double nodeSwapFactor, long indexBufferSize, long indexPageSize, double indexSwapFactor, long dataBufferSize, long dataPageSize, long blockSize, double dataSwapFactor, long maxSizeEntry, int maxSizeKey, Swapper swapper, int quantitySwaperThread, Memory memory) Inicia o cache.
boolean	isDeleteOnExit() Verifica se os arquivos contidos na pasta de dados serão destruidos junto com essa instância.
protected InputStream	putIfAbsentStream(String key, InputStream inputData, long timeToLive, long timeToIdle) Associa o fluxo de bytes do valor à chave somente se a chave não estiver associada a um valor.
protected boolean	putStream(String key, InputStream inputData, long timeToLive, long timeToIdle) Associa o fluxo de bytes do valor à chave.
protected boolean	removeStream(String key) Remove o valor associado à chave.
protected boolean	replaceStream(String key, InputStream inputData, long timeToLive, long timeToIdle) Substitui o fluxo de bytes associado à chave somente se ele existir.
void	setDeleteOnExit(boolean deleteOnExit) Define que os arquivos contidos na pasta de dados sejam destruidos junto com essa instância.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamCache

public StreamCache()

StreamCache

public StreamCache(long nodeBufferSize,
           long nodePageSize,
           double nodeSwapFactor,
           long indexBufferSize,
           long indexPageSize,
           double indexSwapFactor,
           long dataBufferSize,
           long dataPageSize,
           long blockSize,
           double dataSwapFactor,
           long maxSizeEntry,
           int maxSizeKey,
           Swapper swapper,
           int quantitySwaperThread,
           Memory memory)

Cria um novo cache.

Parameters:

nodeBufferSize - Tamanho do buffer, em bytes, onde os nós ficarão armazenados.

nodePageSize - Tamanho da página, em bytes, do buffer de nós.

nodeSwapFactor - Fator de permuta dos nós.

indexBufferSize - Tamanho do buffer, em bytes, onde os índices ficarão armazenados.

indexPageSize - Tamanho da página, em bytes, do buffer de índices.

indexSwapFactor - Fator de permuta dos índices.

dataBufferSize - Tamanho do buffer, em bytes, onde os dados ficarão armazenados.

dataPageSize - Tamanho da página, em bytes, do buffer de dados.

blockSize - Tamanho do bloco, em bytes.

dataSwapFactor - Fator de permuta dos dados.

maxSizeEntry - Tamanho máximo de uma entrada no cache.

maxSizeKey - Tamanho máximo de uma chave.

swapper - Estratégia de troca dos dados entre a memória e outro dispositivo.

quantitySwaperThread - Quantidade de processos usados para fazer a permuta.

memory - Acesso à memória.

Method Detail

init

protected void init(long nodeBufferSize,
        long nodePageSize,
        double nodeSwapFactor,
        long indexBufferSize,
        long indexPageSize,
        double indexSwapFactor,
        long dataBufferSize,
        long dataPageSize,
        long blockSize,
        double dataSwapFactor,
        long maxSizeEntry,
        int maxSizeKey,
        Swapper swapper,
        int quantitySwaperThread,
        Memory memory)

Inicia o cache.

Parameters:

nodeBufferSize - Tamanho do buffer, em bytes, onde os nós ficarão armazenados.

nodePageSize - Tamanho da página, em bytes, do buffer de nós.

nodeSwapFactor - Fator de permuta dos nós.

indexBufferSize - Tamanho do buffer, em bytes, onde os índices ficarão armazenados.

indexPageSize - Tamanho da página, em bytes, do buffer de índices.

indexSwapFactor - Fator de permuta dos índices.

dataBufferSize - Tamanho do buffer, em bytes, onde os dados ficarão armazenados.

dataPageSize - Tamanho da página, em bytes, do buffer de dados.

blockSize - Tamanho do bloco, em bytes.

dataSwapFactor - Fator de permuta dos dados.

maxSizeEntry - Tamanho máximo de uma entrada no cache.

maxSizeKey - Tamanho máximo de uma chave.

swapper - Estratégia de troca dos dados entre a memória e outro dispositivo.

quantitySwaperThread - Quantidade de processos usados para fazer a permuta.

memory - Acesso à memória.

putStream

protected boolean putStream(String key,
                InputStream inputData,
                long timeToLive,
                long timeToIdle)
                     throws StorageException

Associa o fluxo de bytes do valor à chave.

Parameters:

key - chave associada ao fluxo.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

inputData - fluxo de bytes do valor.

Returns:

true se o item for substituido. Caso contrário, false

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

replaceStream

protected boolean replaceStream(String key,
                    InputStream inputData,
                    long timeToLive,
                    long timeToIdle)
                         throws StorageException

Substitui o fluxo de bytes associado à chave somente se ele existir.

Parameters:

key - chave associada ao valor.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

inputData - fluxo de bytes do valor.

Returns:

true se o valor for substituido. Caso contrário, false.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item.

putIfAbsentStream

protected InputStream putIfAbsentStream(String key,
                            InputStream inputData,
                            long timeToLive,
                            long timeToIdle)
                                 throws StorageException

Associa o fluxo de bytes do valor à chave somente se a chave não estiver associada a um valor.

Parameters:

key - chave associada ao valor.

timeToLive - é a quantidade máxima de tempo que um item expira após sua criação.

timeToIdle - é a quantidade máxima de tempo que um item expira após o último acesso.

inputData - fluxo de bytes do valor.

Returns:

fluxo associado à chave ou null.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar inserir o item ou se o item atual expirar no momento da execução do método.

getStream

protected InputStream getStream(String key)
                         throws RecoverException

Obtém o fluxo de bytes do valor associado à chave.

Parameters:

key - chave associada ao fluxo.

Returns:

fluxo de bytes do valor ou null.

Throws:

RecoverException - Lançada se ocorrer alguma falha ao tentar obter o item.

removeStream

protected boolean removeStream(String key)
                        throws StorageException

Remove o valor associado à chave.

Parameters:

key - chave associada ao valor.

Returns:

true se o valor for removido. Caso contrário false.

Throws:

StorageException - Lançada se ocorrer alguma falha ao tentar remover o item.

containsKey

public boolean containsKey(String key)

Verifica se uma chave está associada a um valor.

Parameters:

key - chave associada ao valor.

Returns:

true se a chave estiver associada a um valor. Caso contrário, false.

getCountRead

public long getCountRead()

Obtém a quantidade de itens recuperados.

Returns:

Quantidade de itens recuperados.

getCountWrite

public long getCountWrite()

Obtém a quantidade de itens armazenados.

Returns:

Quantidade de itens armazenados.

getCountRemoved

public long getCountRemoved()

Obtém a quantidade de itens removidos.

Returns:

Quantidade de itens removidos.

getCountReadData

public long getCountReadData()

Obtém a quantidade de bytes recuperados.

Returns:

Quantidade de bytes recuperados.

getCountWriteData

public long getCountWriteData()

Obtém a quantidade de bytes armazenados.

Returns:

Quantidade de bytes armazenados.

getCountRemovedData

public long getCountRemovedData()

Obtém a quantidade de bytes removidos.

Returns:

Quantidade de bytes removidos.

isDeleteOnExit

public boolean isDeleteOnExit()

Verifica se os arquivos contidos na pasta de dados serão destruidos junto com essa instância.

Returns:

true para destruir todos os arquivos. Caso contrário, false.

setDeleteOnExit

public void setDeleteOnExit(boolean deleteOnExit)

Define que os arquivos contidos na pasta de dados sejam destruidos junto com essa instância.

Parameters:

deleteOnExit - true para destruir todos os arquivos. Caso contrário, false.

clear

public void clear()

Remove todas as entradas contidas no cache.

destroy

public void destroy()

Destrói os dados contidos nesta instância. Deve ser executado se isDeleteOnExit() for false.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable