sanspie/itmo-prog-lab-4
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Alexander Karpov 2023-12-12 12:33:07 +03:00
parent d634f98d9e
commit d391c6904a
1 changed files with 0 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
README.md
View File

@ -1,67 +1,3 @@
# itmo-prog-lab-3
## Class Description
### StoryTeller
- The main class of the application. It sets up the story's context, including the city, house, and characters, and initiates the storytelling process.
### Package: characters
- **Character.java**: An abstract class that serves as a base for all character types. It implements `Listenable` and `Conversable` interfaces.
- **Child.java**: Represents a child character. Capable of listening to and asking questions about stories.
- **Traveler.java**: Represents a traveler character. Focuses on telling stories about their adventures.
- **Znayka.java**: A specialized traveler character with additional behaviors.
### Package: enums
- **CharacterType.java**: An enumeration that defines different character types, such as `TRAVELER` and `CHILD`.
### Package: interfaces
- **Listenable.java**: Interface for characters that can listen to stories.
- **Conversable.java**: Interface for characters that can converse about specific subjects in the story.
### Package: model
- **City.java**: Represents a city in the story with a method to simulate the return to daily life with changes.
- **House.java**: Represents a house where characters reside and storytelling occurs.
- **StoryElement.java**: An abstract base class for elements within the story, like City and House.
### Package: story
- **Narrative.java**: Manages a collection of story events.
- **StoryContext.java**: Provides context for the story, linking the city, house, and the overarching story theme.
- **StoryEvent.java**: Represents individual events within the story.
## Interactions and Configurations
- **StoryTeller**: Initializes the storytelling environment by creating a city, a house (Znayka's house), and characters (Znayka, Malish, and Malishka). It then triggers the storytelling process in Znayka's house.
- **Character Classes**: Each character type (`Child`, `Traveler`, `Znayka`) interacts differently within the story. For instance, children listen and ask questions, while travelers focus on narrating their adventures.
- **Interfaces**: `Listenable` and `Conversable` are implemented differently in each character class, providing unique behaviors during storytelling.
- **Model Classes**: `City` and `House` serve as the physical setting for the story. The `House` class, in particular, is the focal point where characters gather and share stories.
- **Story Classes**: `StoryContext` links the narrative's physical setting with the thematic elements, while `Narrative` and `StoryEvent` manage the flow and individual events of the story.
## Given Query
```
На этом знаменитое путешествие Знайки и его товарищей окончилось.
Жизнь в Цветочном городе потекла по-старому... хотя нет, нельзя сказать, чтобы совсем по-старому.
С тех пор как наши отважные путешественники вернулись домой, в городе только и говорили о них.
Все жители, и малыши и малышки, приходили по вечерам к домику Знайки и слушали рассказы путешественников об их жизни в Зеленом городе.
```
## Output
```
Жители Домик Знайки собираются чтобы рассказать истории
Все жители, и малыши и малышки, приходили по вечерам к Домик Знайки и слушали рассказы путешественников.
Жизнь в Цветочный город потекла по-старому... хотя нет, нельзя сказать, чтобы совсем по-старому.
Жители Домик Знайки собираются чтобы рассказать истории
Знайка рассказывает историю о путешествие Знайки в Зеленый город
Малыш слушает историю о путешествие Знайки и спрашивает вопросы о путешествие Знайки в Зеленый город
Малышка слушает историю о путешествие Знайки и спрашивает вопросы о путешествие Знайки в Зеленый город
Знайка рассказывает историю о жизнь в Цветочном городе
Малыш слушает историю о путешествие Знайки и спрашивает вопросы о жизнь в Цветочном городе
Малышка слушает историю о путешествие Знайки и спрашивает вопросы о жизнь в Цветочном городе
Истории захватывали дух, и каждый вечер собирались всё больше жителей, чтобы слышать новые приключения.
```
## UML Diagram
![UML Diagram](https://new.akarpov.ru/media/files/sanspie/tFfur/diagram.svg "https://new.akarpov.ru/files/PRaEOtISfNJAvOZYJbiO")
# itmo-prog-lab-4
## Class Description