Neighbours
Crisopeya IM
v1.0.0

"Neighbours" CrisopeyaTM Information Module
v1.0.0 API Specification

This document is the API specification for the Crisopeya Technology automatically generated Neighbours (external link) Crisopeya Information Module (IM), to be used in the Description

Packages
net.crisopeya.product.Neighbours_qk Accesses Neighbours (external link) IM scheme information.
net.crisopeya.product.Neighbours_qk.data Provides the classes to share Neighbours (external link) IM information between application layers.
net.crisopeya.product.Neighbours_qk.data.common Provides common functionality such as data validation.
net.crisopeya.product.Neighbours_qk.data.models Manages common Neighbours (external link) IM scheme information.
net.crisopeya.product.Neighbours_qk.db Contains the DATABASE LAYER (DB Layer) Neighbours (external link) IM classes.
net.crisopeya.product.Neighbours_qk.db.datamodel Manages Neighbours (external link) IM registers on the database layer.
net.crisopeya.product.Neighbours_qk.db.enhancer Provides the classes necessary to persist and manage Neighbours (external link) IM registers in the datastore.
net.crisopeya.product.Neighbours_qk.db.models Manages database layer Neighbours (external link) IM scheme information.
net.crisopeya.product.Neighbours_qk.ui Contains the USER INTERFACE LAYER (UI Layer) Neighbours (external link) IM classes.
net.crisopeya.product.Neighbours_qk.ui.datamodel Manages Neighbours (external link) IM registers on the user interface layer.
net.crisopeya.product.Neighbours_qk.ui.models Manages UI layer Neighbours (external link) IM scheme information.
net.crisopeya.product.Neighbours_qk.ui.swing Contains the Swing GRAPHICAL USER INTERFACE LAYER (Swing GUI Layer) Neighbours (external link) IM classes.
net.crisopeya.product.Neighbours_qk.ui.swing.components.panels.modelpanels Builds and shows the Neighbours (external link) IM Swing Graphical User Interface (GUI) Panels.
net.crisopeya.product.Neighbours_qk.ui.swing.components.tables Provides the classes necessary to manage Neighbours (external link) IM Swing Graphical User Interface (GUI) Tables and Table Views.
net.crisopeya.product.Neighbours_qk.ui.swing.managers Manages the Neighbours (external link) IM Swing Graphical User Interface (GUI) Panels.
net.crisopeya.product.Neighbours_qk.ui.swing.models Manages Swing Graphical User Interface Layer (GUI) Neighbours (external link) IM scheme information.

 

This document is the API specification for the Crisopeya Technology automatically generated Neighbours (external link) Crisopeya Information Module (IM), to be used in the Crisopeya Information Platform.

The Neighbours (external link) IM has been automatically built and generated using the Crisopeya Software Generating Engine (C-SGE). The Neighbours (external link) IM is designed to be installed on top of the Crisopeya Information Platform to manage the provided information scheme. It uses the Datanucleus Access Platform and is JDO 2.2 and JPA 1 compliant, and it can be used to manage information through more than 35 different databases engines.

Crisopeya Software Applications Architecture

The Crisopeya software applications are based on the Crisopeya Information Platform, on top of which Crisopeya Information Modules (IM) such as this are installed. The Crisopeya Information Platform provides all the generic functionality needed to manage structured information, and Crisopeya Information Modules (IM) such as this Neighbours (external link) IM provide the information scheme to be managed.

The Crisopeya Information Platform on its own can not manage any information, as it only provides generic functionality. To show it graphically, the Crisopeya Information Platform is like a solid block (with all the application layers clearly defined) that has a hole in the middle. Crisopeya Information Modules (IM), such as this Neighbours (external link) Information Module, fill up this gap providing an information scheme implementation.

Crisopeya Architecture for
the Information Platform Crisopeya Architecture for 
Information Modules


The Crisopeya Information Platform together with one or more Crisopeya Information Modules (IM) can be used to manage the structured information implemented on those IMs:

Crisopeya 
Architecture for Software Applications



Crisopeya Software Applications Layers

Both the Crisopeya Information Platform and the Crisopeya Information Modules (IM) are designed using four different layers:


For more information about the Crisopeya Technology and its architecture, see Getting Started with the Crisopeya Technology, Getting Started with the Crisopeya Software 2.0 Community, and the F.A.Q..

"Neighbours" IM User Description

"Information Module" used to manage the buildings owner's data on a community of neighbours, and to manage their quotas payment. For each building Neighbours complete building address, name and surname, id card, building surface, contact phone numbers, e-mail, quota, information whether the neighbour has paid all the quotas and explication in the necessary cases and made observations are stored.

The "Neighbours" IM contains 19 fields:

Long Text
2
Monetary
2
Phone Number
3
Enumerated
1
Email Address
1
Integer
2
Text
7
Boolean
1

Version:
1.0.0, 09/28/08
Author:
C-SGE (crisopeya software generation engine)
See Also:
net.crisopeya.product.Neighbours_qk.data, net.crisopeya.product.Neighbours_qk.db, net.crisopeya.product.Neighbours_qk.ui, net.crisopeya.product.Neighbours_qk.ui.swing

Neighbours
Crisopeya IM
v1.0.0

"CRISOPEYA TEAM"