csbase.logic

Class ClientAlgorithmFile

java.lang.Object

csbase.logic.ClientAlgorithmFile

All Implemented Interfaces:

ClientFile, Serializable, Comparable<ClientAlgorithmFile>

public class ClientAlgorithmFile
extends Object
implements ClientFile, Serializable, Comparable<ClientAlgorithmFile>

Modela a visão que um cliente tem de um arquivo ou diretório de um algoritmo.

Author:

Tecgraf/PUC-Rio

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientAlgorithmFile.AlgorithmFileType Tipo do arquivo na árvore de algoritmos

Field Summary

Fields inherited from interface csbase.logic.ClientFile

OPTIMIZATION_MODE_GLOBAL, OPTIMIZATION_MODE_NONE

Constructor Summary

Constructors

Constructor and Description
ClientAlgorithmFile(AlgorithmInfo algorithmInfo, AlgorithmVersionId versionId, String name, String[] path, ClientAlgorithmFile.AlgorithmFileType treeFileType, boolean isDirectory) Construtor para arquivos de configuração e documentação
ClientAlgorithmFile(AlgorithmInfo algorithmInfo, AlgorithmVersionId versionId, String platformName, String name, String[] path, boolean isDirectory) Construtor para arquivos executáveis
ClientAlgorithmFile(AlgorithmInfo algorithmInfo, AlgorithmVersionId versionId, String platformName, String name, String[] path, long size, ClientAlgorithmFile parent, ClientAlgorithmFile.AlgorithmFileType treeFileType, boolean isDirectory) Construtor

Method Summary

Modifier and Type	Method and Description
boolean	canExecute() Retorna true se o arquivo pode ser executado, false caso contrário.
boolean	canRead() Retorna true se o arquivo pode ser lido, false caso contrário.
boolean	canWrite() Retorna true se o arquivo pode ser escrito, false caso contrário.
void	close(boolean force) Fecha este arquivo.
int	compareTo(ClientAlgorithmFile other)
boolean	equals(Object o) Testa a igualdade de dois arquivos.
boolean	exists() Verifica se o arquivo existe no servidor.
AlgorithmVersionId	getAlgorithmVersion() Obtém a versão do algoritmo que este arquivo está associado.
ClientFile[]	getChildren() Retorna a lista de arquivos deste diretório.
ClientFileType	getClientFileType() Retorna item de enumeração que identifica o tipo do arquivo quanto ao local onde o arquivo está armazenado.
AlgorithmInfo	getInfo() Obtém os dados de um algoritmo.
InputStream	getInputStream() Obtém um fluxo de entrada para leitura do arquivo.
long	getModificationDate() Informa a data da última modificação deste arquivo (formato numérico).
String	getName() Retorna o nome do arquivo.
OutputStream	getOutputStream() Obtém um fluxo de saída para escrita no arquivo.
ClientAlgorithmFile	getParent() Retorna o diretório-pai
String[]	getPath() Retorna o caminho para o arquivo na forma de um array (não inclui o nome do projeto).
String	getPlatformName() Obtém a plataforma associada ao arquivo.
String	getStringPath() Retorna o path pro arquivo na forma de string.
ClientAlgorithmFile.AlgorithmFileType	getTreeFileType() Obtém o tipo do arquivo na árvore de algoritmos.
String	getType() Informa o tipo do arquivo.
static boolean	hasDirectories(ClientAlgorithmFile[] projectFiles) Verifica se algum arquivo de projeto é diretório.
int	hashCode() Redefine a chave pela qual o arquivo deve ser buscado/inserido em hashtables.
boolean	isDirectory() Indica se este arquivo é um diretório.
boolean	isRoot() Indica se este arquivo é o root da arvore.
boolean	isUpdated() Indica se o arquivo está atualizado em relação ao servidor.
void	open(boolean readOnly) Abre o arquivo para leitura ou para leitura e escrita.
long	position() Informa a posição corrente deste arquivo.
void	position(long newPosition) Altera a posição corrente deste arquivo.
int	read(byte[] target, int offset, int length, long position) Lê uma sequência de bytes do arquivo.
int	read(byte[] dst, long position) Lê uma sequência de bytes do arquivo.
void	rename(String fileName) Troca o nome deste arquivo.
void	setName(String name) Muda o nome do arquivo.
void	setParent(ClientAlgorithmFile parent) Redefine o pai do arquivo.
void	setUpdated(boolean updated) Informa se o arquivo está atualizado em relação ao servidor.
long	size() Informa o tamanho corrente deste arquivo.
static String[]	splitPath(String path) Método interno para decomposição de um caminho de arquivo (path) em um array de strings; onde cada elemento é montado no separador "/".
String	toString() Retorna um texto descritivo do arquivo.
void	truncate(long newSize) Ajusta o tamanho corrente deste arquivo.
void	updateInfo() Atualiza as informações desse arquivo buscando os dados reais no servidor.
void	write(byte[] src, int off, int len, long position) Escreve uma sequência de bytes do arquivo.
void	write(byte[] src, long position) Escreve uma sequência de bytes do arquivo.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientAlgorithmFile

public ClientAlgorithmFile(AlgorithmInfo algorithmInfo,
                           AlgorithmVersionId versionId,
                           String name,
                           String[] path,
                           ClientAlgorithmFile.AlgorithmFileType treeFileType,
                           boolean isDirectory)

Construtor para arquivos de configuração e documentação

Parameters:

algorithmInfo - os dados de um algoritmo

versionId - a versão do algoritmo

name - nome do arquivo

path - caminho para o arquivo, a partir da raiz

treeFileType - Tipo do arquivo na árvore de algoritmos

isDirectory - indicativo se é um arquivo ou diretório

ClientAlgorithmFile

public ClientAlgorithmFile(AlgorithmInfo algorithmInfo,
                           AlgorithmVersionId versionId,
                           String platformName,
                           String name,
                           String[] path,
                           boolean isDirectory)

Construtor para arquivos executáveis

Parameters:

algorithmInfo - os dados de um algoritmo

versionId - a versão do algoritmo

platformName - Nome da plataforma

name - nome do arquivo

path - caminho para o arquivo, a partir da raiz

isDirectory - indicativo se é um arquivo ou diretório

ClientAlgorithmFile

public ClientAlgorithmFile(AlgorithmInfo algorithmInfo,
                           AlgorithmVersionId versionId,
                           String platformName,
                           String name,
                           String[] path,
                           long size,
                           ClientAlgorithmFile parent,
                           ClientAlgorithmFile.AlgorithmFileType treeFileType,
                           boolean isDirectory)

Construtor

Parameters:

algorithmInfo - os dados de um algoritmo

versionId - a versão do algoritmo

platformName - nome da plataforma, quando arquivo executável.

name - nome do arquivo

path - caminho para o arquivo, a partir da raiz

size - tamanho do arquivo.

parent - diretório-pai. Se estiver sendo construido no servidor, este valor deve ser null.

treeFileType - Tipo do arquivo na árvore de algoritmos

isDirectory - indicativo se é um arquivo ou diretório

Method Detail

getName

public String getName()

Retorna o nome do arquivo.

Specified by:

getName in interface ClientFile

Returns:

Nome do arquivo.

setName

public void setName(String name)

Muda o nome do arquivo.

Parameters:

name - novo nome do arquivo.

getStringPath

public String getStringPath()

Retorna o path pro arquivo na forma de string.

Specified by:

getStringPath in interface ClientFile

Returns:

O path pro arquivo na forma de string.

getPath

public String[] getPath()

Retorna o caminho para o arquivo na forma de um array (não inclui o nome do projeto).

Specified by:

getPath in interface ClientFile

Returns:

Caminho para o arquivo na forma de um array (não inclui o nome do projeto).

getType

public String getType()

Informa o tipo do arquivo.

Specified by:

getType in interface ClientFile

Returns:

O tipo do arquivo.

getParent

public ClientAlgorithmFile getParent()

Retorna o diretório-pai Este método não deve ser utilizado no servidor pois o valor da propriedade a que ele referencia só será atribuido no cliente.

Specified by:

getParent in interface ClientFile

Returns:

o diretório que contem este arquivo.

setParent

public void setParent(ClientAlgorithmFile parent)

Redefine o pai do arquivo.

Parameters:

parent - novo pai

getChildren

public ClientFile[] getChildren()
                         throws Exception

Description copied from interface: ClientFile

Retorna a lista de arquivos deste diretório.

Specified by:

getChildren in interface ClientFile

Returns:

A lista de arquivos deste diretório.

Throws:

Exception - Erro na busca de arquivos do diretório.

updateInfo

public void updateInfo()
                throws RemoteException

Atualiza as informações desse arquivo buscando os dados reais no servidor.

Throws:

RemoteException - Falha de rmi

isDirectory

public boolean isDirectory()

Indica se este arquivo é um diretório.

Specified by:

isDirectory in interface ClientFile

Returns:

Verdadeiro caso seja um diretório e falso caso contrário.

size

public long size()

Informa o tamanho corrente deste arquivo. Reflete o número corrente de bytes do arquivo.

Specified by:

size in interface ClientFile

Returns:

Tamanho corrente do arquivo.

getModificationDate

public long getModificationDate()

Informa a data da última modificação deste arquivo (formato numérico).

Specified by:

getModificationDate in interface ClientFile

Returns:

data da última modificação deste arquivo (formato numérico)

isUpdated

public boolean isUpdated()

Indica se o arquivo está atualizado em relação ao servidor.

Returns:

true se está atualizado

setUpdated

public void setUpdated(boolean updated)

Informa se o arquivo está atualizado em relação ao servidor.

Parameters:

updated - true se está atualizado.

exists

public boolean exists()
               throws RemoteException

Verifica se o arquivo existe no servidor.

Specified by:

exists in interface ClientFile

Returns:

true se o arquivo existe no servidor.

Throws:

RemoteException - se houver falha de RMI

rename

public void rename(String fileName)
            throws RemoteException

Troca o nome deste arquivo.

Parameters:

fileName - Novo nome do arquivo.

Throws:

RemoteException - falha de rmi

splitPath

public static String[] splitPath(String path)

Método interno para decomposição de um caminho de arquivo (path) em um array de strings; onde cada elemento é montado no separador "/".

Parameters:

path - o caminho lógico do arquivo.

Returns:

o array.

truncate

public void truncate(long newSize)
              throws IOException

Ajusta o tamanho corrente deste arquivo.

Parameters:

newSize - o novo tamanho a ser ajustado.

Throws:

IOException - Em caso de erro.

open

public void open(boolean readOnly)
          throws RemoteException

Abre o arquivo para leitura ou para leitura e escrita.

Specified by:

open in interface ClientFile

Parameters:

readOnly - Boolean indicando se o arquivo deve ser aberto para leitura ou para leitura e escrita.

Throws:

RemoteException

position

public long position()

Informa a posição corrente deste arquivo. Reflete o número de bytes a partir do início do arquivo até a posição corrente.

Specified by:

position in interface ClientFile

Returns:

Posição corrente do arquivo.

position

public void position(long newPosition)
              throws IOException

Altera a posição corrente deste arquivo. Reflete o número de bytes a partir do início do arquivo até a posição corrente.

Specified by:

position in interface ClientFile

Parameters:

newPosition - Nova posição corrente do arquivo.

Throws:

IOException - Em caso de erro.

read

public int read(byte[] dst,
                long position)
         throws IOException

Lê uma sequência de bytes do arquivo. Esse método tenta fazer leituras consecutivas até conseguir a quantidade de bytes solicitada, ou atingir o final do arquivo. Caso não consiga recuperar a quantidade solicitada sem ter atingido o final do arquivo (isto é, por problemas de comunicação ou outros), o método lança uma exceção.

Specified by:

read in interface ClientFile

Parameters:

dst - O array a ser preenchido.

position - A posição do arquivo a partir da qual a leitura deve ser iniciada.

Returns:

A quantidade de bytes lidos. Se for menor que o número de bytes solicitados, o final do arquivo foi atingido.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

read

public int read(byte[] target,
                int offset,
                int length,
                long position)
         throws IOException

Lê uma sequência de bytes do arquivo. Esse método tenta fazer leituras consecutivas até conseguir a quantidade de bytes solicitada, ou atingir o final do arquivo. Caso não consiga recuperar a quantidade solicitada sem ter atingido o final do arquivo (isto é, por problemas de comunicação ou outros), o método lança uma exceção.

Specified by:

read in interface ClientFile

Parameters:

target - O array a ser preenchido.

offset - O deslocamento no array a partir do qual os bytes serão armazenados.

length - A quantidade de bytes a serem lidos do arquivo.

position - A posição do arquivo a partir da qual a leitura deve ser iniciada.

Returns:

A quantidade de bytes lidos. Se for menor que o número de bytes solicitados, o final do arquivo foi atingido.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

write

public void write(byte[] src,
                  long position)
           throws IOException,
                  FileLockedException

Escreve uma sequência de bytes do arquivo. Esse método tenta fazer escritas consecutivas até conseguir enviar a quantidade de bytes solicitada. Caso não consiga, o método lança uma exceção.

Specified by:

write in interface ClientFile

Parameters:

src - O array contendo os bytes a serem escritos no arquivo.

position - A posição do arquivo a partir da qual a escrita deve ser iniciada.

Throws:

IOException - Em caso de erro.

FileLockedException - caso o arquivo esteja bloqueado para escrita por outra sessão de usuário

write

public void write(byte[] src,
                  int off,
                  int len,
                  long position)
           throws IOException,
                  FileLockedException

Escreve uma sequência de bytes do arquivo. Esse método tenta fazer escritas consecutivas até conseguir enviar a quantidade de bytes solicitada. Caso não consiga, o método lança uma exceção.

Specified by:

write in interface ClientFile

Parameters:

src - O array contendo os bytes a serem escritos no arquivo.

off - O deslocamento no array a partir do qual os bytes serão lidos.

len - A quantidade de bytes a serem escritos do arquivo.

position - A posição do arquivo a partir da qual a escrita deve ser iniciada.

Throws:

IOException - Em caso de erro.

FileLockedException - caso o arquivo esteja bloqueado para escrita por outra sessão de usuário

close

public void close(boolean force)
           throws RemoteException,
                  IOException

Fecha este arquivo. Após chamado este método, o objeto que representa o arquivo não poderá mais ser utilizado para leitura e/ou escrita.

Specified by:

close in interface ClientFile

Parameters:

force - Indica que o arquivo deve ser considerado fechado mesmo em caso de erro.

Throws:

IOException - se houver falha no acesso ao arquivo.

RemoteException

toString

public String toString()

Retorna um texto descritivo do arquivo.

Overrides:

toString in class Object

Returns:

.

equals

public boolean equals(Object o)

Testa a igualdade de dois arquivos. Dois ClientProjectFile são considerados iguais se seus paths absolutos forem os mesmos.

Overrides:

equals in class Object

Parameters:

o - Objeto a ser comparado com o atual

Returns:

true se ambos os objetos forem considerados iguais

getInfo

public AlgorithmInfo getInfo()

Obtém os dados de um algoritmo.

Returns:

os dados de um algoritmo.

getAlgorithmVersion

public AlgorithmVersionId getAlgorithmVersion()

Obtém a versão do algoritmo que este arquivo está associado.

Returns:

a versão do algoritmo que este arquivo está associado.

getPlatformName

public String getPlatformName()

Obtém a plataforma associada ao arquivo.

Returns:

platformName

hashCode

public int hashCode()

Redefine a chave pela qual o arquivo deve ser buscado/inserido em hashtables.

Overrides:

hashCode in class Object

Returns:

chave para inserção/busca em hashtables.

compareTo

public int compareTo(ClientAlgorithmFile other)

Specified by:

compareTo in interface Comparable<ClientAlgorithmFile>

hasDirectories

public static boolean hasDirectories(ClientAlgorithmFile[] projectFiles)

Verifica se algum arquivo de projeto é diretório.

Parameters:

projectFiles - Os arquivos que se deseja verificar.

Returns:

true, caso algum dos arquivos de projeto seja diretório, ou false, caso contrário.

isRoot

public boolean isRoot()

Indica se este arquivo é o root da arvore.

Returns:

Retorna boolean indicando se este arquivo é o root da arvore.

getInputStream

public InputStream getInputStream()
                           throws IOException

Obtém um fluxo de entrada para leitura do arquivo.

Specified by:

getInputStream in interface ClientFile

Returns:

Fluxo de entrada para leitura do arquivo.

Throws:

IOException - Caso ocorra algum erro de IO durante o procedimento.

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Obtém um fluxo de saída para escrita no arquivo.

Specified by:

getOutputStream in interface ClientFile

Returns:

Fluxo de saída para escrita no arquivo.

Throws:

IOException - Caso ocorra algum erro de IO durante o procedimento.

getClientFileType

public ClientFileType getClientFileType()

Retorna item de enumeração que identifica o tipo do arquivo quanto ao local onde o arquivo está armazenado.

Specified by:

getClientFileType in interface ClientFile

Returns:

Item de enumeração que identifica o tipo do arquivo quanto ao local onde o arquivo está armazenado.

getTreeFileType

public ClientAlgorithmFile.AlgorithmFileType getTreeFileType()

Obtém o tipo do arquivo na árvore de algoritmos. isExecutableFile

Returns:

treeFileType o tipo do arquivo na árvore de algoritmos.

canExecute

public boolean canExecute()

Retorna true se o arquivo pode ser executado, false caso contrário.

Specified by:

canExecute in interface ClientFile

Returns:

true se o arquivo pode ser executado, false caso contrário.

canRead

public boolean canRead()

Retorna true se o arquivo pode ser lido, false caso contrário.

Specified by:

canRead in interface ClientFile

Returns:

true se o arquivo pode ser lido, false caso contrário.

canWrite

public boolean canWrite()

Retorna true se o arquivo pode ser escrito, false caso contrário.

Specified by:

canWrite in interface ClientFile

Returns:

- true se o arquivo pode ser escrito, false caso contrário.