CSE 210: Programação com Classes

Lembre-se:

• Cada variável membro deve ser privada. Getters e Setters devem ser usados para acessar os dados, se necessário.
• Os getters não devem ter nenhum parâmetro e não devem solicitar nada ao usuário, mas, em vez disso, simplesmente retornar um valor.
• Os setters devem aceitar um único parâmetro e ter um tipo de retorno void.

• O programa pode terminar de duas maneiras: ou o usuário digita sair ou todas as palavras na escritura foram escondidas.

As seguintes são boas opções de classes, listadas com suas responsabilidades:

• Escritura: Mantém o controle tanto da referência quanto do texto da escritura. É possível esconder palavras e obter a exibição renderizada do texto.
• Referencia: Mantém o controle das informações do livro, capítulo e versículo.
• Palavra: Mantém o controle de uma única palavra e se ela está exibida ou escondida.

Os principais comportamentos da classe Escritura são esconder palavras aleatórias e também obter o texto de exibição como uma string. (O "texto de exibição" refere-se ao texto com algumas palavras exibidas normalmente e outras substituídas por sublinhados.) Também seria interessante ter um comportamento para verificar se a escritura está completamente escondida, para que você saiba quando encerrar o programa.

Os principais comportamentos da classe Palavra são esconder e exibir uma palavra e verificar se uma palavra está escondida ou não. Além disso, uma Palavra deve ter um comportamento para obter o texto de exibição dessa palavra, que seria a própria palavra (por exemplo, "oração") ou, se a palavra estivesse escondida, esse comportamento retornaria sublinhados (por exemplo, "______").

A classe Referencia é bem simples no que diz respeito a comportamentos. Ela deve ter a capacidade de obter o texto de exibição da referência, que é apenas uma sequência de caracteres que combina o livro, o capítulo e o versículo (ou versículos). Você pode considerar ter getters e setters para cada um dos elementos de dados que esta classe armazena, mas pode ser ainda melhor usar um construtor para defini-los. O construtor será discutido com mais detalhes abaixo.

Converter essas ideias em nomes de métodos concisos nos dá o seguinte (observe que os tipos de variáveis e os tipos de retorno são mostrados após o caractere de dois-pontos : ):

• Escritura
  • EsconderPalavrasAleatorias(numeroParaEsconder : int) : void
  • ObterTexto() : string
  • EstaCompletamenteEscondida() : bool
• Palavra
  • Esconder() : void
  • Exibir() : void
  • EstaEscondida() : bool
  • ObterTexto() : string
• Referencia
  • ObterTexto() : string
  • Possíveis getters e setters

A classe Escritura precisará de variáveis membro para uma referência e uma lista de todas as palavras da escritura. O tipo de dados para a referência é Referencia, a classe personalizada definida acima. O tipo de dados para a lista de palavras seria List<Palavra> (observe que é uma lista de objetos Palavra, em vez de uma lista de strings.)

A classe Palavra precisará armazenar o texto da palavra em si (uma string) e uma variável para indicar se essa palavra está exibida ou escondida (um booleano).

A classe Referencia precisará armazenar uma variável para o livro (string), o capítulo (inteiro) e o versículo (inteiro). Então, também precisará armazenar uma variável adicional para o segundo, ou "fim", versículo do intervalo para lidar com o caso de Provérbios 3:5-6.

A seguir são mostradas todas as variáveis-membro:

• Escritura
  • _referencia : Referencia
  • _palavras : List<Palavra>
• Palavra
  • _texto : string
  • _estaEscondida : bool
• Referencia
  • _livro : string
  • _capitulo : int
  • _versiculo : int
  • _ultimoVersiculo : int

Uma classe para uma Escritura precisará de um construtor que aceite tanto uma referência quanto o texto da escritura. Se a classe Escritura armazena internamente uma Lista de objetos Palavra, a primeira ideia seria passar uma variável List<Palavra> para o construtor. Embora isso pudesse funcionar, teria algumas desvantagens. Em primeiro lugar, isso exporia o armazenamento interno das escrituras para a pessoa que usa a classe (perdendo os benefícios do encapsulamento). Em segundo lugar, exigiria que a pessoa que usa a classe fizesse o trabalho de dividir o texto na lista, da maneira que essa classe espera. Isso não só representa trabalho extra, mas também quebra o princípio do encapsulamento e limita sua capacidade de alterar sua classe no futuro.

Em vez de passar uma lista de palavras, seria melhor se o princípio de encapsulamento fosse seguido passando uma string que fosse o texto da escritura. Então, o construtor teria a responsabilidade de criar a lista e dividir as palavras na string para criar objetos Palavra para cada uma e colocá-las na lista.

Embora incluir a lógica de criação da lista de palavras possa parecer muito trabalho para o construtor, é útil encapsular essa lógica na classe Escritura para que outro código não precise se preocupar com o armazenamento interno do Escritura. Isso permitiria que o programa fosse facilmente alterado no futuro, caso uma escolha de implementação diferente fosse feita.

Uma classe para uma Palavra também precisará de um construtor. Este construtor deve aceitar o texto da palavra para salvá-lo como um atributo. Além disso, o construtor precisará definir a visibilidade inicial da palavra (se ela será mostrada ou escondida). Observe que você não precisa passar a visibilidade da palavra. Ela pode ser definida para ficar visível por padrão.

Uma classe para uma Referencia deve ter dois construtores diferentes para dar conta de casos em que há um único versículo ou vários versículos. Observe que você pode ter dois construtores diferentes, desde que o conjunto de parâmetros seja diferente. O primeiro construtor receberia apenas um livro, capítulo e versículo, enquanto o segundo receberia um livro, capítulo, versículo inicial e versículo final. (Essa capacidade de ter várias versões de uma função, desde que o conjunto de parâmetros sejam diferentes, é chamada de Sobrecarga de Função (overloading) e é possível com qualquer função, não apenas com construtores.)

A seguir está um diagrama de classe final para cada uma das classes que você pode usar como um guia enquanto escreve seu código.