csbase.server.services.projectservice

Class ProjectFileTypeRepository

java.lang.Object

csbase.server.services.projectservice.ProjectFileTypeRepository

public final class ProjectFileTypeRepository
extends Object

Repositório de tipos de arquivo de projeto ProjectFileTypeInfo: responsável por ler o arquivo de tipos de arquivos de projeto. O arquivo tipos de arquivos de projetos é um arquivo cujo formato é Properties. Ele descreve todos os tipos de arquivos de projeto . Um exemplo de trecho deste arquivo é: filetype.0.typeCode=UNKNOWN filetype.UNKNOWN.description_pt_BR=Desconhecido filetype.UNKNOWN.description_en_US=Unknown filetype.UNKNOWN.description_es_AR=Desconocido filetype.UNKNOWN.baseIcon=/resources/filetypes/other.gif filetype.UNKNOWN.ucIcon=/resources/filetypes/other_uc.gif filetype.UNKNOWN.cutIcon=/resources/filetypes/other_cut.gif filetype.UNKNOWN.mimeType=application/zip filetype.1.typeCode=TEXT filetype.TEXT.description_pt_BR=Texto filetype.TEXT.description_en_US=Text filetype.TEXT.description_es_AR=Texto filetype.TEXT.baseIcon=/resources/filetypes/text.gif filetype.TEXT.ucIcon=/resources/filetypes/text_uc.gif filetype.TEXT.cutIcon=/resources/filetypes/text_cut.gif filetype.TEXT.mimeType=text/plain filetype.TEXT.extensions=txt filetype.2.typeCode=HTML filetype.HTML.description_pt_BR=HTML filetype.HTML.description_en_US=HTML filetype.HTML.description_es_AR=HTML filetype.HTML.baseIcon=/resources/filetypes/html.gif filetype.HTML.ucIcon=/resources/filetypes/html_uc.gif filetype.HTML.cutIcon=/resources/filetypes/html_cut.gif filetype.HTML.mimeType=text/html filetype.HTML.extensions=html,htm Todas as chaves começam por filetype seguidas por um número sequencial ou o código do tipo. O número sequencial começa por 0 e o incremento é 1. Logo no exemplo, temos 3 tipos cadastrados. Formato Código: é o formato código que informam o código de tipo de arquivo. Ele é: filetype.N.typeCode, onde N é o número sequencial. Exemplo: TEXT, que é o valor da chave filetype.1.typeCode, é o código de arquivos de projeto do tipo texto. Há 2 formatos possíveis para as demais informações. São eles:

• Formato Regular: filetype.TYPE_CODE.INFO, onde TYPE_CODE é o código do tipo e INFO é o nome do atributo.
• Formato com Idioma: filetype.TYPE_CODE.INFO_LOCALE, onde TYPE_CODE é o código do tipo, INFO é o nome do atributo e o LOCATE é o idioma. O idioma

Informações com Formato Regular:

• baseIcon: informa o caminho para o arquivo contendo o ícone base do tipo. É obrigatória. Exemplo: /resources/filetypes/text.gif é o caminho para o arquivo que é o ícone base de arquivos tipo texto.
• ucIcon: informa o caminho para o arquivo contendo o ícone "sob construção" do tipo. É obrigatória. Exemplo: /resources/filetypes/text_uc.gif é o caminho para o arquivo que é o ícone "sob construção" de arquivos tipo texto.
• cutIcon: informa o caminho para o arquivo contendo o ícone "cortado" do tipo. É obrigatória. Exemplo: /resources/filetypes/text_uc.gif é o caminho para o arquivo que é o ícone "cortado" de arquivos tipo texto.
• mimeType: informa o MIME type para o tipo de arquivo. É opcional. Exemplo: text/html é o MIME type para arquivos de projeto do tipo HTML.
• extensions: informa as extensões válidas para o tipo de arquivo. O seu valor é uma lista, cujos valores são separados por vírgula. É opcional. Exemplo: html e htm são extensões para o arquivos tipo HTML.

Informações com Formato com Idioma:

• description_LOCALE: informa a descrição do tipo para um idioma específico. É obrigatória. Pode haver 1 ou mais. Haverá uma chave para cada idioma. Exemplo: Texto, que é o valor da chave filetype.TEXT.description_pt_BR, é a descrição para o arquivo tipo texto, no idioma Português Brasileiro.

As informações para o tipo desconhecido ProjectFileType.UNKNOWN são obrigatórias, ou seja, para que o repositório funcione corretamente é necessário ter uma sessão semelhante a: filetype.0.typeCode=UNKNOWN filetype.UNKNOWN.description_pt_BR=Desconhecido filetype.UNKNOWN.description_en_US=Unknown filetype.UNKNOWN.description_es_AR=Desconocido filetype.UNKNOWN.baseIcon=/resources/filetypes/other.gif filetype.UNKNOWN.ucIcon=/resources/filetypes/other_uc.gif filetype.UNKNOWN.cutIcon=/resources/filetypes/other_cut.gif filetype.UNKNOWN.mimeType=application/zip Não é obrigatório que este tipo seja o primeiro. Na ausência de informações nos outros tipos, o sistema assume valores para evitar a falha, porém gera aviso.

• Na ausência da descrição, o sistema utiliza o próprio código do tipo;
• Na ausência do mime-type, o sistema utiliza o mime-type padrão DEFAULT_MIME_TYPE ;
• Na ausência de algum ícone, o sistema utiliza o ícone base do tipo desconhecido ProjectFileType.UNKNOWN, na ausência do ícone base do tipo desconhecido, ele utilizará um vetor 0 bytes.

Author:

Tecgraf/PUC-Rio

Constructor Summary

Constructors

Constructor and Description
ProjectFileTypeRepository(String path) Cria um repositório.

Method Summary

Modifier and Type	Method and Description
csbase.logic.ProjectFileTypeInfo	findInfoByExtension(Locale locale, String extension) Procura um tipo de arquivo que aceitam a extensão informada.
Set<csbase.logic.ProjectFileTypeInfo>	findInfosByExtension(Locale locale, String extension) Procura os tipos de arquivo que aceitam a extensão informada.
csbase.logic.ProjectFileTypeInfo	getInfo(Locale locale, String code) Obtém informações sobre o tipo de arquivo cujo código foi informado, respeitando o idioma informado.
Map<String,csbase.logic.ProjectFileTypeInfo>	getInfos(Locale locale) Obtém as informações dos tipos de arquivos para um idioma específico.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectFileTypeRepository

public ProjectFileTypeRepository(String path)

Cria um repositório.

Parameters:

path - O caminho para o arquivo que contém as informações sobre os tipos de arquivos de projeto (Não pode ser null).

Method Detail

getInfos

public Map<String,csbase.logic.ProjectFileTypeInfo> getInfos(Locale locale)

Obtém as informações dos tipos de arquivos para um idioma específico.

Parameters:

locale - O idioma (não pode ser null).

Returns:

Um mapa associativo que associa o código e o tipo do arquivo. O mapa retornado é imutável.

getInfo

public csbase.logic.ProjectFileTypeInfo getInfo(Locale locale,
                                                String code)

Obtém informações sobre o tipo de arquivo cujo código foi informado, respeitando o idioma informado.

Parameters:

locale - O idioma (Não pode ser null).

code - O código. Se for null serão retornadas as informações do tipo desconhecido (ProjectFileType.UNKNOWN).

Returns:

As informações do tipo de arquivo.

Throws:

csbase.exception.ServiceFailureException - Se houver um erro de E/S ao ler o arquivo path. Se for necessário obter as informações do tipo desconhecido (ProjectFileType.UNKNOWN) e essas informações não existirem.

findInfosByExtension

public Set<csbase.logic.ProjectFileTypeInfo> findInfosByExtension(Locale locale,
                                                                  String extension)

Procura os tipos de arquivo que aceitam a extensão informada.

Parameters:

locale - O idioma (Não pode ser null).

extension - A extensão. (Não pode ser null).

Returns:

Um conjunto com os tipos de arquivos que aceitam a extensão. Caso nenhum tipo aceite a extensão, será retornado um conjunto vazio. O counjunto é imutável.

Throws:

csbase.exception.ServiceFailureException - Se houver um erro de E/S ao ler o arquivo path.

findInfoByExtension

public csbase.logic.ProjectFileTypeInfo findInfoByExtension(Locale locale,
                                                            String extension)

Procura um tipo de arquivo que aceitam a extensão informada. Se houver mais do que 1 tipo de arquivo que aceite a extensão, ele retornará 1 deles e registrará um log como aviso para alertar do problema.

Parameters:

locale - O idioma (Não pode ser null).

extension - A extensão. (Não pode ser null).

Returns:

Um conjunto com os tipos de arquivos que aceitam a extensão. Caso não haja extensão adequada, ele retornará o Tipo Desconhecido.

Throws:

csbase.exception.ServiceFailureException - Se houver um erro de E/S ao ler o arquivo path. Se for necessário obter as informações do tipo desconhecido ( ProjectFileType.UNKNOWN) e essas informações não existirem.