csbase.logic

Class ClientSGAFile

java.lang.Object

csbase.logic.ClientSGAFile

All Implemented Interfaces:

ClientFile, Serializable

public class ClientSGAFile
extends Object
implements ClientFile, Serializable

Define um arquivo que se encontra na máquina do SGA e que está visível para o cliente.

Author:

Tecgraf

See Also:

Serialized Form

Field Summary

Fields inherited from interface csbase.logic.ClientFile

OPTIMIZATION_MODE_GLOBAL, OPTIMIZATION_MODE_NONE

Constructor Summary

Constructors

Constructor and Description
ClientSGAFile(String sgaName) Construtor padrão que assume como path inicial "/".
ClientSGAFile(String sgaName, String path) Construtor padrão.

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.
boolean	equals(Object obj)
boolean	exists() Retorna se existe o arquivo físico.
List<ClientSGAFile>	getBrothers() Retorna lista com os irmãos selecionados.
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.
InputStream	getInputStream() Obtém um fluxo de entrada para leitura do arquivo.
String	getLinkPath() Retorna o path real para o arquivo caso o path seja um link simbólico.
long	getModificationDate() Consulta a data/hora da última modificação do arquivo.
String	getName() Retorna o nome do arquivo.
OutputStream	getOutputStream() Obtém um fluxo de saída para escrita no arquivo.
ClientFile	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	getSeparator() Separador usado pelos paths da máquina do SGA.
String	getSGAName() Nome do SGA.
String	getStringPath() Retorna o path pro arquivo na forma de string.
String	getType() Informa o tipo do arquivo.
int	hashCode()
boolean	isDir() Retorna true se o path apontar para um diretório, false caso contrário.
boolean	isDirectory() Consulta se um arquivo é diretório.
boolean	isSymbolicLink() Retorna true se o path for um link simbólico, false caso contrário.
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[] dst, int off, int len, long position) Lê uma seqüência de bytes deste arquivo a partir da posição fornecida.
int	read(byte[] dst, long position) Lê uma seqüência de bytes deste arquivo a partir da posição fornecida.
void	setCanExecute(boolean canExecute) True se o arquivo pode ser executado, false caso contrário.
void	setCanRead(boolean canRead) True se o arquivo pode ser lido, false caso contrário.
void	setCanWrite(boolean canWrite) True se o arquivo pode ser escrito, false caso contrário.
void	setDir(boolean isDir) True se o path apontar para um diretório, false caso contrário.
void	setLinkPath(String linkPath) Path real para o arquivo caso o path seja um link simbólico.
void	setSeparator(String separator) Separador usado pelos paths da máquina do SGA.
void	setSize(long size) Tamanho do arquivo.
void	setSymbolicLink(boolean isSymbolicLink) True se o path for um link simbólico, false caso contrário.
long	size() Informa o tamanho corrente deste arquivo.
String	toString()
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

ClientSGAFile

public ClientSGAFile(String sgaName)

Construtor padrão que assume como path inicial "/".

Parameters:

sgaName - - nome do SGA.

ClientSGAFile

public ClientSGAFile(String sgaName,
                     String path)

Construtor padrão.

Parameters:

sgaName - - nome do SGA.

path - - path do arquivo que está no SGA.

Method Detail

getSGAName

public String getSGAName()

Nome do SGA.

Returns:

nome do SGA.

isDir

public boolean isDir()

Retorna true se o path apontar para um diretório, false caso contrário.

Returns:

true se o path apontar para um diretório, false caso contrário.

setDir

public void setDir(boolean isDir)

True se o path apontar para um diretório, false caso contrário.

Parameters:

isDir - - true se o path apontar para um diretório, false caso contrário.

setSeparator

public void setSeparator(String separator)

Separador usado pelos paths da máquina do SGA.

Parameters:

separator - - separador usado pelos paths da máquina do SGA.

getSeparator

public String getSeparator()

Separador usado pelos paths da máquina do SGA.

Returns:

- separador usado pelos paths da máquina do SGA.

setCanRead

public void setCanRead(boolean canRead)

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

Parameters:

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

setCanWrite

public void setCanWrite(boolean canWrite)

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

Parameters:

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

setCanExecute

public void setCanExecute(boolean canExecute)

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

Parameters:

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

setSize

public void setSize(long size)

Tamanho do arquivo.

Parameters:

size - - tamanho do arquivo.

getLinkPath

public String getLinkPath()

Retorna o path real para o arquivo caso o path seja um link simbólico.

Returns:

path real para o arquivo caso o path seja um link simbólico.

isSymbolicLink

public boolean isSymbolicLink()

Retorna true se o path for um link simbólico, false caso contrário.

Returns:

true se o path for um link simbólico, false caso contrário.

setLinkPath

public void setLinkPath(String linkPath)

Path real para o arquivo caso o path seja um link simbólico.

Parameters:

linkPath - - path real para o arquivo caso o path seja um link simbólico.

setSymbolicLink

public void setSymbolicLink(boolean isSymbolicLink)

True se o path for um link simbólico, false caso contrário.

Parameters:

isSymbolicLink - - true se o path for um link simbólico, false caso contrário.

getBrothers

public List<ClientSGAFile> getBrothers()

Retorna lista com os irmãos selecionados.

Returns:

lista com os irmãos selecionados.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

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.

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.

exists

public boolean exists()
               throws IOException

Retorna se existe o arquivo físico.

Specified by:

exists in interface ClientFile

Returns:

indicativo

Throws:

IOException - em caso de falha e I/O no procedimento.

getChildren

public ClientFile[] getChildren()
                         throws Exception

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.

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.

getName

public String getName()

Retorna o nome do arquivo.

Specified by:

getName in interface ClientFile

Returns:

Nome do arquivo.

getParent

public ClientFile getParent()

Retorna o diretório-pai

Specified by:

getParent in interface ClientFile

Returns:

o diretório que contem este arquivo.

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).

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.

getType

public String getType()

Informa o tipo do arquivo.

Specified by:

getType in interface ClientFile

Returns:

O tipo do arquivo.

isDirectory

public boolean isDirectory()

Consulta se um arquivo é diretório.

Specified by:

isDirectory in interface ClientFile

Returns:

indicativo

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

Consulta a data/hora da última modificação do arquivo.

Specified by:

getModificationDate in interface ClientFile

Returns:

a data

close

public void close(boolean force)
           throws 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.

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.

open

public void open(boolean readOnly)
          throws Exception

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:

Exception - Erro na abertura do arquivo.

position

public long position()
              throws IOException

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.

Throws:

IOException - Em caso de erro.

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 Exception

Lê uma seqüência de bytes deste arquivo a partir da posição fornecida.

Specified by:

read in interface ClientFile

Parameters:

dst - O array no qual os bytes serão escritos.

position - A posição do arquivo a partir do qual os bytes serão lidos.

Returns:

O número de bytes lidos.

Throws:

Exception - Em caso de erro.

read

public int read(byte[] dst,
                int off,
                int len,
                long position)
         throws Exception

Lê uma seqüência de bytes deste arquivo a partir da posição fornecida.

Specified by:

read in interface ClientFile

Parameters:

dst - O array no qual os bytes serão escritos.

off - O índice do array a partir do qual os bytes serão escritos.

len - O número de bytes a ler do arquivo e escrever no array.

position - A posição do arquivo a partir do qual os bytes serão lidos.

Returns:

O número de bytes lidos.

Throws:

Exception - Em caso de erro.

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

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