XML E DOM no desenvolvimento de um Sistema de Armazenamento e Manipulação de Documentos Jurídicos

Transcrição

1 XML E DOM no desenvolvimento de um Sistema de Armazenamento e Manipulação de Documentos Jurídicos Bruno Vilar 1, Thiago da Silva Borges 1, Parcilene Fernandes de Brito 1, Jackson Gomes de Souza 1 1 Curso de Sistemas de Informação Centro Universitário Luterano de Palmas (CEULP/ULBRA) Caixa Postal Palmas TO Brasil {brunovilar,thiago, pfb, jgomes}@ulbra-to.br Abstract. This paper presents the steps realized to develop an application for legal documents management, using XML files the data base that will store the information of those documents. The Java programming language and the API for XML documents processing: DOM, are used to process form data and to store these data in XML files. By that way, also is possible to validate the content of each legal document, according with a document type definition, DTD, created to describe the structure (elements and the relation between them) of each document. Resumo. Este artigo apresenta os passos realizados no desenvolvimento de um aplicativo para gerenciamento de documentos jurídicos, utilizando arquivos XML como banco de dados, para armazenamento das informações dos documentos. A linguagem Java e a API para processamento de documentos XML: DOM, são utilizados para processamento dos dados dos formulários e armazenamento destes em arquivos XML. Desta forma, é possível, ainda, validar o conteúdo de cada documento jurídico de acordo com uma definição de tipo de documento, DTD, criada para descrever a estrutura (elementos e relação entre estes) de cada documento. 1. Introdução Esse artigo tem como objetivo o desenvolvimento de um sistema de armazenamento e manipulação de documentos jurídicos. Para isso, foi utilizada a linguagem XML (extensible Markup Language) para a estruturação dos documentos e a API (Application Programmer Interface ) DOM (Document Object Model) para a sua manipulação no ambiente Java. A proposta de utilização de um padrão de estruturação de documentos como XML foi definida a partir da necessidade de uma manipulação mais eficiente desses documentos. Esse trabalho está sendo desenvolvido como parte do portal gerencial do Centro Universitário Luterano de Palmas (CEULP/ULBRA) e, como tal, objetiva melhorar o tratamento dado ao grande número de informações nessa área que circulam diariamente na instituição. O trabalho em questão visa organizar o conteúdo dos documentos. Possibilitando, assim, uma distinção entre seus elementos (por exemplo, cláusulas de um contrato) para a realização de pesquisas mais elaboradas.

2 2. XML e DOM 2.1 extensible Markup Language A XML é um padrão para publicação, combinação e intercâmbio de documentos multimídia, desenvolvido pelo consórcio W3C (World Wide Web Consortium) (W3C, 2003). Foi desenvolvida como um subconjunto simplificado da SGML (Standard Generalized Markup Language), caracteriza-se, assim, como uma linguagem de marcação de documentos, cujo objetivo principal é possibilitar a entrega de estruturas de dados auto-descritivas de diferentes complexidades para aplicações que requerem tais estruturas ( FLO, 1999). A XML, como outras linguagens de marcação, lida com instruções embutidas no corpo de documentos chamadas tags (marcas), que permitem a descrição de dados. No entanto, como suas tags são auto-descritivas, pela possibilidade de construção da sintaxe do documento, é possível atingir uma flexibilidade maior e uma descrição bem mais eficiente dos dados por elas armazenados. Estruturalmente, cada documento XML consiste de um conjunto de elementos, delimitados por uma tag inicial e uma tag final. Cada elemento tem um tipo, identificado por um nome, e pode ter um conjunto de especificações de atributos. Cada especificação de atributo tem um nome e um valor. Adicionalmente cada elemento pode ter também uma lista arbitrária de sub-elementos (FLO, 1999). O interesse aplicado ao XML como um padrão para intercâmbio está relacionado ao tipo de dado com que seus documentos são armazenados. A fácil interpretação de caracteres UNICODE, representada como elementos que podem ser efetivamente validados, de acordo com uma estrutura pré-definida, a que se deve manter correspondência, permite que documentos sejam trocados e processados por diferentes sistemas, preservando as informações que seus dados representam. Para o desenvolvimento da XML, alguns objetivos foram apresentados e delineados (BRAY et al., 2000; LIGHT, 1999): ser usada de forma direta na Internet; suportar uma grande variedade de aplicações; ser compatível com a SGML; ser fácil escrever programas que processam documentos XML; o número de recursos opcionais em XML deve ser mantido em um valor mínimo, de preferência zero; os documentos XML devem ser legíveis e razoavelmente claros aos usuários; o modelo XML deve ser formal e conciso; os documentos XML devem ser fáceis de criar; Documentos XML são ditos como bem formados quando não possuem restrições quanto a marcas, nomes de atributos ou outros padrões. Um documento XML pode vir ainda acompanhado de uma DTD (Document Type Definition), a qual é essencialmente uma gramática que especifica as marcas e a estrutura de um documento. Quando um documento XML satisfaz uma gramática este é considerado válido (GOLDMAN, 1999). Desta forma, o DTD fornece um conjunto de regras para o documento XML associado a ele, estas regras vão desde a definição do tipo dos elementos, sua multiplicidade, até a definição de possíveis atributos. O conteúdo é o valor atribuído aos elementos no documento XML. A estrutura especificada em um DTD, segundo sua definição no padrão SGML, possui uma propriedade importante: apenas a estrutura lógica de um documento é descrita, não sendo fornecida nenhuma informação sobre a semântica de apresentação do documento (BROWN, 1989).

3 2.2 Document Object Model A API DOM fornece uma interface independente de plataforma e linguagem para a estrutura e o conteúdo de documentos HTML e XML. Ela descreve uma linguagem neutra capaz de representar qualquer documento HTML ou XML bem formado em forma de uma árvore e tratar a informação armazenada nesses documentos como um modelo de objetos hierárquicos (IDRIS, 1999). Sua interface principal é formada por um conjunto de interfaces que a compõem, indo da representação de um documento até seus nodos, oferecendo recursos que são disponibilizados de acordo com o objeto a qual representam. O DOM vem a ser utilizado a partir de uma API que implementa sua interface em uma determinada linguagem. Esta, de acordo com o padrão em que foi modelado, deve oferecer recursos de orientação a objetos. A API DOM trabalha armazenando o documento XML em memória, após ter seu conteúdo separado em elementos, que posteriormente são dispostos como uma árvore. Como informações que constituem o conteúdo do documento, são considerados elementos, atributos, comentários e instruções de processamento. Esta forma de trabalhar o documento permite que seus elementos sejam acessados e trabalhados como nós de uma árvore, que possuem como referência nós pais, filhos e irmãos. Tais referências fornecem um meio para que a árvore seja percorrida, de forma recursiva, tendo como critério de seleção de um elemento não apenas seu nome, mas sua relação com os demais nós, tornando-o independente de sua gramática. Enquanto o documento XML é mantido na memória é possível não só realizar consultas, mas criar, apagar, copiar e mover nós. Na figura 1, é apresentada a estrutura hierárquica do DOM. Nela é possível verificar que cada elemento é representado por um nó. E que os nós podem conter ou outros nós ou um valor determinado(string, integer). A camada do DOM que permite realizar operações sobre o conteúdo dos elementos da árvore XML é a de nível 1, já revisada e em estado de recomendação pelo W3C. Outras camadas já estão em estudo, revisão, ou mesmo sob recomendação, como a de nível 2, que se propõe a realizar operações relacionadas à outras extensões, como folhas de estilo e filtragem de documentos HTML e XML. Documento XML Documento XML CONVENIO PARTE <CONVENIO> <PARTE> PFISICA NOME= Paulo RG= CPF= <PFISICA> <NOME >Paulo</NOME>

4 <RG>333333</RG> <CPF> </CPF> Figura 1: Representação da estrutura hierárquica do DOM A API do DOM no Java é fornecida pelo pacote org.w3c.dom, porém para sua implementação são utilizados recursos do pacote javax.xml.parsers. A seguir são descritas as classes obtidas pela implementação da interface definida pelo DOM, bem como das classes necessárias para essa implementação. Package javax.xml.parsers: Pacote da API do Java que oferece classes que permitem realizar o processamento de dados XML. DocumentBuilderFactory: Classe do pacote javax.xml.parsers que oferece recursos necessários a uma API para que a mesma possa realizar o parsing de um documento XML e gerar um objeto que constitui sua representação em árvore. DocumentBuilder: Classe que, através dos recursos obtidos da classe DocumentBuilderFactory, implementa a API que verifica a validade de um documento XML e armazena sua estrutura numa instância da classe Document. Document: É o objeto raiz do DOM, representando o documento XML. Todos os nós que farão parte do documento ficam armazenados dentro deste objeto. NodeList: Constitui uma lista de nós, formada pelos elementos de um determinado de um determinado nível ou com uma data característica em comum. Cada nó pode ser acessado a partir de um índice, através do método item(). Uma NodeList pode ser obtida através dos métodos getelementsbytagname( ) e getelementsbytagnamens( ), que retornam uma lista de nós a partir do nome de um conjunto de tags ou através de nome e espaços de nome, respectivamente. Node: Objeto que representa um nó na árvore gerada pelo DOM, possuindo uma interface para cada tipo de informação dentro do documento XML, além de um conjunto de métodos que referenciam nós pai, filhos e irmãos, além de permitir realizar ações com relação a eles. Element: Estabelece a representação de um elemento do documento XML, disponibilizando métodos que oferecem ações sobre as características de uma tag, como retornar nome ou atributo. Attribute: Objeto que representa o atributo de um elemento no documento, permitindo que o mesmo seja acessado e modificado. O acesso realizado ao documento é iniciado com a instanciação da classe DocumentBuilderFactory e a partir desta a instanciação da classe DocumentBuilder. A representação em árvore do documento é criada a partir do momento que se declara um

5 objeto da classe Document, que recebe o resultado obtido através do parsing do documento, realizado pela instância da classe DocumentBuilder (Figura 2). DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); DocumentBuilder db = dbf.newdocumentbuilder(); Document documento = db.parse( caminho_documento ); Figura 2: Instanciação inicial Para manter a arvore XML em memória, é preciso utilizar as Classes DocumentBuilderFactory e DocumentBuilder, para só então realizar seu encapsulamento através da classe Document. Tendo o documento armazenado em memória, de acordo com o apresentado na figura 1, pode-se ter acesso aos elementos do documento a partir da tag raiz, que pode ser obtida pelo método getdocumentelement() e armazenada em uma objeto Element, conforme apresentado na figura 3. Element elemento = documento.getdocumentelement(); Figura 3: O armazenamento do elemento raiz do documento XML A partir do momento que se tem uma referência ao elemento raiz é possível chegar à qualquer outro elemento dentro da árvore, utilizando percursos orientados de acordo com a hierarquia dos nós ou de uma determinada característica que o distingue. A exemplo de um acesso ao primeiro filho do elemento raiz, tem-se o código apresentado na figura 4, em que um objeto Node recebe o primeiro filho do elemento raiz, acessado pelo método getfirstchild( ). Node filho = elemento getfirstchild(); Figura 4: Utilização do método getfirstchild( ) Um recurso interessante para o acesso e manipulação de um elemento que possui mais de uma ocorrência dentro do documento é o método item(); da classe NodeList, que realiza uma tarefa de indexação a um conjunto de elementos. O armazenamento, e posteriormente acesso, de um determinado número de elementos pode ser observado na figura 5. NodeList clausulas = elemento.getelementsbytagname( CLAUSULAS ); Node clausula = clausulas.item(0); Figura 5: Utilização do método item() Os elementos que possuem como tag o nome CLAUSULAS são retornados para a NodeList clausulas. O acesso a um dos nós é efetuado pelo método item(), que neste caso está retornando o elemento obtido como resultado da primeira ocorrência de uma tag CLAUSULA. Cabe ressaltar que os acessos realizados até o momento apenas permitiram estar apontando para um determinado nó ou elemento, mas não recuperar seu valor ou algum de seus atributos. Para a realização do mesmo é preciso utilizar um método que retorne o mesmo, como pode ser visto na figura 6. Element tag_clausula = (Element) clausula; String nome_clausula = tag_clausula.getattribute("nome"); Figura 6: Recuperar o valor de um atributo A princípio, o nó clausula é convertido, através de casting, para um objeto Element, permitindo que seus atributos e valor sejam acessados. Após convertido, seu

6 atributo nome é recuperado e armazenado em uma String, por meio do método getattribute( ), definido na interface do objeto Element. Partindo da criação lógica dos elementos, e seu armazenamento temporário em memória, tem-se a perspectiva de mantê-los fisicamente em forma de arquivo, garantindo assim a possibilidade de recuperar suas informações posteriormente. A forma de armazenar tais informações é realizada mantendo os elementos criados dentro de um documento XML. Classes e métodos, pertencentes a API do Java, utilizados para salvar em disco a árvore criada pelo DOM, serão analisadas adiante. Package javax.xml.transform: Constitui um pacote para a criação de objetos e templates que permitem dispor uma árvore XML sob diferentes representações. TransformerFactory: permite obter um objeto Transformer, com origem em sua instância, abrindo a possibilidade para a definição de um template, que define recursos utilizados para gerar uma transformação por meio de uma linguagem de folhas de estilo. Transformer: classe que oferece recursos para transformar uma árvore XML em uma representação diferente de sua origem. Como resultado, pode-se obter uma representação em texto simples ou em uma determinada linguagem de marcação. DOMSource: permite armazenar uma árvore, ou um de seus nós, representando uma sub-árvore, para uma posterior transformação à partir da classe Transformer. StreamResult: obtém o resultado da transformação de um objeto DOMSource através de sua transformação através de um objeto Transformer. O processo de gravação da árvore em um documento XML deve ser iniciado criando um objeto Transformer à partir da instanciação da classe TransformerFactory (Figura 7). TransformerFactory transfact = TransformerFactory.newInstance(); Transformer trans = transfact.newtransformer(); Figura 7: Criando um objeto Transformer Após serem instanciadas as classes que permitem realizar a transformação da árvore XML são definidos os objetos que constituem a origem e o destino do processo de transformação, realizados pelo método transform(), pertencente à classe Transformer. Os objetos de origem e destino, que através do processo realizado resultam na gravação do documento, são respectivamente instanciados a partir das classes DOMSource e StreamResult(Figura 8). DOMSource origem = new DOMSource(documento); StreamResult destino = new StreamResult("juridico.xml"); transformer transform(origem, destino); Figura 8: Origem e Destino do processo de transformação O trabalho de leitura, manipulação e gravação de um documento XML, à partir da API do DOM e em conjunto com os recursos do Java, são terminados, gerando como resultado um documento bem formado, capaz de ser interpretado por outros sistemas. 3. O Sistema O sistema tem como objetivo o armazenamento de documentos jurídicos e sua manipulação, a partir de uma estruturação eficiente dos dados. Para isso, optou-se por trabalhar com a linguagem XML, por esta permitir a criação de documentos a partir de

7 um processo de definição de tags auto-descritivas e da possibilidade de validar o documento a partir de uma DTD. O domínio do trabalho são documentos jurídicos, mais especificamente, contratos e convênios. A idéia básica é permitir ao usuário uma flexibilidade na construção de tais documentos, sem, no entanto, definir estruturas mal formadas. 3.1 A estrutura A partir dos modelos dos documentos jurídicos (contratos, convênios), foi definida a estrutura. Na figura 9 é apresentada a DTD de um documento do tipo convênio. Nela, são especificados cada elemento que o documento possui, sua multiplicidade e até a definição de possíveis atributos. <?xml version="1.0"?> <!DOCTYPE JURIDICO[ <!ELEMENT CONVENIO (PARTE, CLAUSULAS)> <!ELEMENT PARTE (PFISICA PJURIDICA)> <!ELEMENT PJURIDICA (NOMEORGAO, NOMEFANTASIA, ENDERECO, CGC, (INSCESTADUAL INSCMUNICIPAL), REPRESENTANTE)> <!ELEMENT PFISICA (NOME, RG, CPF, ENDERECO, PROFISSAO, ESTADOCIVIL)> <!ELEMENT REPRESENTANTE (PFISICA,CARGO)> <!ELEMENT CLAUSULAS (CLAUSULA+, OBJETO, VIGENCIA, OBRIGACOES, RESCISAO)> <!ELEMENT CLAUSULA (DESCRICAO, CLAUSULA*)> <!ELEMENT DESCRICAO (#PCDATA)> <!ELEMENT OBJETO (#PCDATA)> <!ELEMENT VIGENCIA (EMPTY)> <!ELEMENT OBRIGACOES (#PCDATA)> <!ELEMENT RESCISAO (EMPTY)> <!ELEMENT NOMEORGAO (#PCDATA)> <!ELEMENT NOMEFANTASIA (#PCDATA)> <!ELEMENT ENDERECO (#PCDATA)> <!ELEMENT CGC (#PCDATA)> <!ELEMENT INSCESTADUAL (#PCDATA)> <!ELEMENT INSCMUNICIPAL (#PCDATA)> <!ELEMENT NOME (#PCDATA)> <!ELEMENT RG (#PCDATA)> <!ELEMENT CPF (#PCDATA)> <!ELEMENT PROFISSAO (#PCDATA)> <!ELEMENT ESTADOCIVIL (#PCDATA)> <!ATTLIST CLAUSULA ID CDATA #IMPLIED> <!ATTLIST CLAUSULA NOME CDATA #IMPLIED> <!ATTLIST VIGENCIA TIPO (DETERMINADO INDETERMINADO) "DETERMINADO"> <!ATTLIST VIGENCIA DATA CDATA #IMPLIED> <!ATTLIST RESCISAO QUANTDIAS CDATA #IMPLIED> ]> Figura 9: DTD do documento juridico convênio A estrutura prevê como elemento raiz a representação de um convênio, formada por uma parte e um conjunto de cláusulas. A parte pode vir a ser definida como uma pessoa física, ou jurídica, prevendo um conjunto de elementos e atributos relevantes a cada opção. Cláusulas, representada por um item, é constituída por um ou mais elementos do tipo cláusula, bem como dos elementos objeto, vigência, obrigações e rescisão. Uma cláusula possui um conjunto próprio de elementos, que são uma descrição e ainda a possibilidade de conter, ou não, sub-cláusulas. Estas possuem a mesma formação que a clausula que a contém Interface com o usuário Os documentos, de quaisquer tipos (convênios, contratos e etc.), são armazenados em arquivos XML diferentes. Como os documentos são interpretados como arquivos diferentes, cada arquivo XML possui as informações pertinentes a um único documento jurídico.

8 As informações requeridas do usuário são preenchidas em um formulário, como demonstra a Figura 10. Conforme o tipo da Parte ( Pessoa Física ou Pessoa Jurídica ), dados distintos são apresentados: para Pessoa Física : Nome, RG, CPF, Endereço, Profissão, Estado Civil ; para Pessoa Jurídica : Nome do órgão (ou organização), Nome fantasia, Endereço, CGC, Inscrição Estadual (ou Municipal ), informações pessoais do representante legal da organização (os mesmos dados de Pessoa física, com adição de Cargo ). Figura 10 : Formulário principal do sistema Atenção especial deve ser dada à seção Cláusulas, onde é possível realizar o gerenciamento das cláusulas do documento: quando um documento é criado, várias cláusulas (obrigatórias: Do Objeto, Da Vigência, Das Obrigações e Da Rescisão ) são criadas automaticamente; posteriormente, o usuário poderá realizar a edição das mesmas. Além disso, é possível criar quantas cláusulas (e sub-cláusulas) forem necessárias para o documento jurídico. A Figura 11 demonstra o formulário de edição de cláusulas.

9 Figura 11: formulário de edição de cláusulas Através da utilização destes formulários, o usuário terá flexibilidade para a criação do documento jurídico, visto que é possível inserir cláusulas, além das que devem existir obrigatoriamente Representação dos dados em XML As Figuras 12 e 13 demonstram a relação entre os dados no documento XML e a apresentação dos mesmos de forma visual (na interface com o usuário). <clausula id= 1 nome= Do Objeto > Este Convênio tem por objeto proporcionar estágio curricular e extracurricular aos Acadêmicos regularmente matriculados e com freqüência efetiva em todas as áreas de graduação da CONVENIENTE, na estrutura da CONVENIADA. <clausula id= 1 nome= > O estágio deve proporcionar ao Estagiário complementação de ensino e aprendizagem, sendo instrumento de integração em termos de treinamento prático, de aperfeiçoamento técnicocultural, científico e em obediência do Regulamento expedido pela CONVENIADA, em se tratando de estágio curricular. </clausula> </clausula> Figura 12: Trecho do conteúdo de um convênio no documento XML As cláusulas e as sub-cláusulas são ordenadas e identificadas no documento XML (atributo id ) de acordo com a ordem em que são inseridas no sistema. No caso do documento apresentado pelas Figuras 12 e 13, a sub-cláusula com identificador ( id ) com valor 1 não possui valor para o atributo nome, por esta razão, na interface, o nome é demonstrado como (sem nome).

10 Figura 13 : Trecho do conteúdo de um convênio apresentado na interface 4. Considerações Finais O trabalho realizado teve por objetivo ir além do desenvolvimento de uma ferramenta para criação de documentos jurídicos, buscando formas de ampliar a capacidade de leitura, compreensão e manipulação destes documentos a partir de um formato flexível de armazenamento. Tal ampliação é realizada de forma irrestrita à própria ferramenta. Os documentos gerados poderão ser trabalhados de forma independente do software aplicado, característica explicada pela adoção da linguagem XML para a gravação destes documentos. A manipulação dos documentos foi realizada através da implementação da API do DOM em Java, cuja linguagem serviu como base para a implementação do editor. Como trabalhos futuros podem ser adotados o padrão RDF (Resource Description Framework), como forma de descrever os documentos e suas informações e Ontologias, tratando, assim, problemas como ambigüidade de informações, além do estudo de linguagens de marcação, com origem no XML, próprias para documentos jurídicos. 5. Referências Bray, T.; Paoli, J.; Sperberg-McQueen, C. M.; Maler, E. Extensible Markup Language (XML) 1.0 (Second Edition). Outubro, Último acesso em: 05/09/2003. Disponível em: Brown, H. Standards for Structured Documents. The Computer Journal, v. 32, n. 6, pp , Idris, N. Should I use SAX or DOM?. Maio, Último acesso em: 12/09/2003. Disponível em: Light, R. Iniciando em XML. Makron Books, Florescu, D.; Kossmann, D. A Performance Evaluation of Alternative Mapping Schemes for Storing XML Data in a Relational Database. INRIA: [s.n.], Goldman, R. et al. From Semistructrured Data to XML: Migrating the Lore Data Model and Query Language. Stanford University, Último acesso em: 12 agosto de Disponível em: < stanford.edu/pub/papers>. W3C, 2003, Extensible Markup Language. Último acesso em: 10/09/2003. Disponível em: