COBOL - Character-strings - XML-EVENT



Desenvolvido por DORNELLES Carlos Alberto - Analista de Sistemas - Brasília DF. - cad_cobol@hotmail.com

COBOL - Character-strings - XML-EVENT
Enterprise COBOL for z/OS 6.3.0, Language Reference

O registro especial XML-EVENT comunica informações de eventos do analisador XML para o procedimento de processamento identificado na instrução XML PARSE.
Antes de passar o controle para o procedimento de processamento, o analisador XML define o registro especial XML-EVENT como o nome do evento XML.
Os eventos específicos e os registros especiais associados configurados dependem da configuração da opção do compilador XMLPARSE, XMLPARSE (XMLSS) ou XMLPARSE (COMPAT).

O analisador usa os seguintes registros especiais quando XMLPARSE (XMLSS) está em vigor:

  • XML-CODE
  • XML-EVENT
  • XML-TEXT ou XML-NTEXT
  • XML-NAMESPACE ou XML-NNAMESPACE
  • XML-NAMESPACE-PREFIX ou XML-NNAMESPACE-PREFIX

O analisador usa os seguintes registros especiais quando XMLPARSE (COMPAT) está em vigor:

  • XML-CODE
  • XML-EVENT
  • XML-TEXT ou XML-NTEXT

O analisador define XML-NTEXT como texto XML associado quando o documento XML está em um item de dados nacional e define XML-TEXT quando o documento XML está em um item de dados alfanuméricos.
Quando a opção do compilador XMLPARSE (COMPAT) está em vigor, o analisador configura XML-NTEXT para o texto de qualquer referência de caractere numérico (para eventos ATTRIBUTE-NATIONAL-CHARACTER e CONTENT-NATIONAL-CHARACTER), independentemente do tipo de dados do documento XML item.

Quando a opção do compilador XMLPARSE (XMLSS) está em vigor, o analisador define XML-NNAMESPACE e XML-NNAMESPACE-PREFIX quando o documento XML está em um item de dados nacional e quando a frase RETURNING NATIONAL é especificada na instrução XMLPARSE; caso contrário, o analisador definirá XML-NAMESPACE e XML-NAMESPACE-PREFIX.

Tabela 1 mostra eventos XML e conteúdo especial do registro para análise com as opções XMLPARSE (XMLSS) e XMLPARSE (COMPAT).

XML-EVENT tem a definição implícita:

       01  XML-EVENT USAGE DISPLAY PICTURE X(30) VALUE SPACE.

Quando usado em programas aninhados, esse registro especial é definido implicitamente com o atributo global no programa mais externo.

O XML-EVENT não pode ser usado como um item de dados de recebimento.

Tabela 1. Eventos XML e Conteúdo do Registro Especial Associado

XML-EVENT XMLPARSE(XMLSS)1 XMLPARSE(COMPAT)1
ATTRIBUTE-CHARACTER n/a5 XML-TEXT ou XML-NTEXT contém o caracter único que corresponde à referência de entidade predefinida no valor do atributo.
ATTRIBUTE-CHARACTERS XML-TEXT ou XML-NTEXT contém o valor entre aspas ou apóstrofos.
Isso pode ser uma substring do valor do atributo.		 XML-TEXT ou XML-NTEXT contém o valor entre aspas ou apóstrofos.
Pode ser uma substring do valor do atributo se o valor incluir uma referência de caractere ou uma referência de entidade.
ATTRIBUTE-NAME Para nomes de atributos que não estão em um espaço para nome, XML-TEXT ou XML-NTEXT contém o nome do atributo.

Para atributos com nomes em um espaço para nome não padrão, os nomes dos atributos sempre são prefixados e têm o formato: prefix: local-part = "AttValue".

XML-TEXT ou XML-NTEXT contém a parte local, XML-NAMESPACE ou XML-NNAMESPACE contém o identificador de namespace e XML-NAMESPACE-PREFIX ou XML-NNAMESPACE-PREFIX contém o prefixo.		 XML-TEXT ou XML-TEXT contém o nome do atributo (a sequência à esquerda do sinal de igual).
ATTRIBUTE-NATIONAL-CHARACTER Independentemente do tipo de documento XML, XML-TEXT está vazio com comprimento zero e XML-NTEXT contém o caractere nacional único que corresponde à referência de caractere numérico.2 O conteúdo XML-TEXT ou XML-NTEXT é igual ao XMLPARSE (XMLSS).
COMMENT XML-TEXT ou XML-NTEXT contém o texto do comentário entre a sequência de caracteres de abertura "".
Isso pode ser uma substring do texto.		 XML-TEXT ou XML-NTEXT sempre contém o texto completo do comentário.
CONTENT-CHARACTER n/a5 XML-TEXT ou XML-NTEXT contém o caracter único que corresponde à referência de entidade predefinida no conteúdo do elemento.
CONTENT-CHARACTERS XML-TEXT ou XML-NTEXT contém o conteúdo de caractere do elemento entre as tags de início e fim.
Isso pode ser uma substring do conteúdo.		 XML-TEXT ou XML-NTEXT contém o conteúdo de caractere do elemento entre as tags de início e fim.
Pode ser uma substring do conteúdo do caractere se o conteúdo incluir uma referência de caractere ou uma referência de entidade.
CONTENT-NATIONAL-CHARACTER Independentemente do tipo de documento XML, XML-TEXT está vazio com comprimento zero e XML-NTEXT contém o caractere nacional único que corresponde à referência de caractere numérico.2 O conteúdo XML-TEXT ou XML-NTEXT é igual ao XMLPARSE (XMLSS).
DOCUMENT-TYPE-DECLARATION XML-TEXT ou XML-NTEXT contém o nome do elemento raiz, conforme especificado na descrição do tipo de documento. XML-TEXT ou XML-NTEXT contém toda a declaração do tipo de documento, incluindo as seqüências de caracteres de abertura e fechamento "".
ENCODING-DECLARATION XML-TEXT ou XML-NTEXT contém o valor, entre aspas ou apóstrofes, da declaração de codificação na declaração XML. O conteúdo XML-TEXT ou XML-NTEXT é igual ao XMLPARSE (XMLSS).
END-OF-CDATA-SECTION Todos os registros especiais XML, exceto XML-CODE e XML-EVENT, estão vazios com comprimento zero. XML-TEXT ou XML-NTEXT contém a cadeia "]]>".
END-OF-DOCUMENT Todos os registros especiais XML, exceto XML-CODE e XML-EVENT, estão vazios com comprimento zero. O conteúdo XML-TEXT ou XML-NTEXT é igual ao XMLPARSE (XMLSS).
END-OF-ELEMENT XML-TEXT ou XML-NTEXT contém a parte local da tag do elemento final ou o nome da tag do elemento vazio.

Se o nome do elemento estiver em um espaço para nome não padrão, XML-NAMESPACE ou XML-NNAMESPACE conterá o identificador do espaço para nome.

Se o nome do elemento estiver em um espaço para nome e tiver o prefixo (no formato prefix:local-part), XML-NAMESPACE-PREFIX ou XML-NNAMESPACE-PREFIX conterá o prefixo.		 XML-TEXT or XML-NTEXT contains the name of the end element tag or empty element tag.
END-OF-INPUT Todos os registros especiais XML, exceto XML-CODE e XML-EVENT, estão vazios com comprimento zero.

Para analisar um segmento adicional de um documento XML, mova o próximo segmento para o identificador-1 e defina XML-CODE como 1.		 n/a6
EXCEPTION XML-CODE contém o código de retorno exclusivo e o código de razão que identifica a exceção.

XML-TEXT ou XML-NTEXT contém o fragmento do documento até o ponto do erro ou anomalia que causou a exceção.4

Todos os outros registradores especiais XML estão vazios com comprimento zero.		 XML-CODE contém o código de erro exclusivo que identifica a exceção.3

XML-TEXT ou XML-NTEXT contém a parte do documento que foi digitalizada com sucesso, incluindo e até o ponto em que a exceção foi detectada.
NAMESPACE-DECLARATION XML-TEXT e XML-NTEXT estão ambos vazios com comprimento zero.

XML-NAMESPACE ou XML-NNAMESPACE contém o identificador de espaço para nome declarado. Se o espaço para nome for "não declarado" especificando a cadeia vazia, XML-NAMESPACE e XML-NNAMESPACE estarão vazios com comprimento zero.

XML-NAMESPACE-PREFIX ou XML-NNAMESPACE-PREFIX contém o prefixo se a declaração do namespace estiver no formato xmlns: prefix = "namespace-identifier"; caso contrário, se a declaração for para o namespace padrão e, portanto, o nome do atributo for xmlns, XML-NAMESPACE-PREFIX e XML-NNAMESPACE-PREFIX estarão ambos vazios com comprimento zero.		 n/a6

(Os eventos ATTRIBUTE-NAME e ATTRIBUTE-CHARACTERS são sinalizados.)
PROCESSING-INSTRUCTION-DATA XML-TEXT ou XML-NTEXT contém o restante da instrução de processamento (após o nome do destino), não incluindo a sequência de fechamento "?>", Mas incluindo caracteres de espaço em branco à direita e não à esquerda.

Isso pode ser uma substring dos dados da instrução de processamento.		 XML-TEXT ou XML-NTEXT sempre contém os dados completos das instruções de processamento.
PROCESSING-INSTRUCTION-TARGET XML-TEXT ou XML-NTEXT contém o nome do destino da instrução de processamento, que ocorre imediatamente após a sequência de abertura da instrução de processamento, "
Este evento pode ocorrer várias vezes para uma determinada instrução de processamento: uma ocorrência anterior a cada substring dos dados.		 O conteúdo XML-TEXT ou XML-NTEXT é igual ao XMLPARSE (XMLSS).
Este evento ocorre apenas uma vez para uma determinada instrução de processamento.
STANDALONE-DECLARATION XML-TEXT ou XML-NTEXT contém o valor entre aspas ou apóstrofos ("yes" ou "no") da declaração autônoma na declaração XML. O conteúdo XML-TEXT ou XML-NTEXT é igual ao XMLPARSE (XMLSS).
START-OF-CDATA-SECTION Todos os registros especiais XML, exceto XML-CODE e XML-EVENT, estão vazios com comprimento zero. XML-TEXT ou XML-NTEXT contém a sequência "
START-OF-DOCUMENT Todos os registros especiais XML, exceto XML-CODE e XML-EVENT, estão vazios com comprimento zero. XML-TEXT ou XML-NTEXT contém o documento inteiro.
START-OF-ELEMENT XML-TEXT ou XML-NTEXT contém a parte local do nome da marca do elemento inicial ou a parte local do nome da marca do elemento vazio.

Se o nome do elemento estiver em um espaço para nome, XML-NAMESPACE ou XML-NNAMESPACE conterá o identificador do espaço para nome.

Se o nome do elemento estiver em um espaço para nome e tiver o prefixo (no formato prefixo: parte local, XML-NAMESPACE-PREFIX ou XML-NNAMESPACE-PREFIX conterá o prefixo).		 XML-TEXT ou XML-NTEXT contém o nome da tag do elemento inicial ou da tag do elemento vazio, também conhecido como o tipo de elemento.
UNKNOWN-REFERENCE-IN-ATTRIBUTE n/a5

Para XMLPARSE (XMLSS), o analisador sempre sinaliza EXCEPTION.

 XML-TEXT ou XML-NTEXT contém o nome de referência da entidade, sem incluir os "&" e ";" delimitadores.
UNKNOWN-REFERENCE-IN-CONTENT n/a5

Para XMLPARSE (XMLSS), o analisador sinaliza UNRESOLVED-REFERENCE ou EXCEPTION.

Consulte "Referências não resolvidas" abaixo para obter detalhes adicionais.

 XML-TEXT ou XML-NTEXT contém o nome de referência da entidade, sem incluir os "&" e ";" delimitadores.
UNRESOLVED-REFERENCE XML-TEXT ou XML-NTEXT contém o nome da entidade do conteúdo XML, não incluindo os "&" e ";" delimitadores.

Consulte "Referências não resolvidas" abaixo para obter detalhes adicionais.		 n/a6

(O analisador sinaliza UNKNOWN-REFERENCE-IN-CONTENT.)
VERSION-INFORMATION XML-TEXT ou XML-NTEXT contém o valor, entre aspas ou apóstrofes, das informações da versão na declaração XML. O conteúdo XML-TEXT ou XML-NTEXT é igual ao XMLPARSE (XMLSS).
  1. Para todos os eventos, exceto EXCEPTION, XML-CODE contém zero.
    Salvo indicação em contrário, os registros XML do namespace (XML-NAMESPACE, XML-NNAMESPACE, XML-NAMESPACE-PREFIX e XML-NNAMESPACE-PREFIX) estão vazios e têm comprimento zero.

  2. Caracteres nacionais com valores escalares maiores que 65.535 (NX "FFFF") são representados usando duas unidades de codificação (um "par substituto").
    Os programadores são responsáveis ??por garantir que as operações no conteúdo do XML-NTEXT não dividam o par de unidades de codificação que juntas formam um caractere gráfico, formando dados inválidos.

  3. Para XMLPARSE (COMPAT), as exceções para conflitos de codificação são sinalizadas antes do início da análise.
    Para essas exceções, XML-TEXT ou XML-NTEXT tem comprimento zero ou contém apenas o valor da declaração de codificação do documento.
    Consulte XML PARSE exceptions with XMLPARSE(COMPAT) no Enterprise COBOL Programming Guide para obter informações sobre códigos de exceção XML.

  4. Se um evento XML END-OF-INPUT ocorreu anteriormente e o procedimento de processamento forneceu um novo segmento de documento, XML-TEXT ou XML-NTEXT conterá apenas o novo segmento.

    Se a anomalia ocorrer antes do início da análise (por exemplo, a especificação de codificação é inválida), XML-TEXT ou XML-NTEXT estarão vazios com comprimento zero.

    O fragmento pode ou não incluir a anomalia. Para um nome de atributo duplicado, por exemplo, o fragmento inclui o atributo incorreto.
    Para um caractere inválido, o fragmento inclui o texto do documento até, mas não incluindo, o caractere inválido.

  5. n/a. Não aplicável; ocorre apenas com XMLPARSE (COMPAT).
  6. n/a. Não aplicável; ocorre apenas com XMLPARSE (XMLSS).

Referências não resolvidas:

Uma referência de entidade não resolvida é uma referência ao nome de uma entidade que não possui declaração na definição de tipo de documento (DTD).

O analisador sinaliza um evento UNRESOLVED-REFERENCE apenas se todas as seguintes condições forem verdadeiras:

  • A referência não resolvida está no conteúdo do elemento, não em um valor de atributo.
  • O documento XML começa com uma declaração XML que especifica standalone = "no".
  • O documento XML contém uma declaração de tipo de documento, por exemplo, 
       <!DOCTYPE rootElementName>
  • Se a frase VALIDATING for especificada na instrução XML PARSE, a declaração do tipo de documento também deverá especificar um subconjunto DTD externo, por exemplo: 
       <!DOCTYPE rootElementName SYSTEM "someOther.dtd">
Caso contrário, o analisador sinaliza um evento EXCEPTION em vez de UNRESOLVED-REFERENCE.


© Copyright IBM Corp.