Thursday, October 21, 2010

Data Access Prototype Description

Hexsoft.Knots.DataAccess.PointData
Represent the point data access.
Methods:
  • Add(System.Guid,System.Int32,System.Int32,System.Int32,System.Int32)
    Add the point.
    Parameters:
    • id: The id of the point.
    • line: The line of the point.
    • x: The x of the point.
    • y: The y of the point.
    • z: The z of the point.
  • Set(System.Guid,System.Int32,System.Int32,System.Int32,System.Int32)
    Set the point.
    Parameters:
    • id: The id of the point.
    • line: The line of the point.
    • x: The x of the point.
    • y: The y of the point.
    • z: The z of the point.
  • Remove(System.Guid)
    Remove the point.
    Parameters:
    • id: The id of the point.
  • GetById(System.Guid)
    Get the point by id.
    Parameters:
    • id: The id of the point.
    Returns:
    • The point entity.
  • GetAll()
    Get all the points.
    Returns:
    • The Point entities.
Hexsoft.Knots.DataAccess.UserData
Represent the user data access.
Methods:
  • Add(System.Guid,System.String,System.String,System.String)
    Add the user.
    Parameters:
    • id: The id of the user.
    • name: The name of the user.
    • email: The email of the user.
    • password: The password of the user.
  • Set(System.Guid,System.String,System.String,System.String)
    Set the user.
    Parameters:
    • id: The id of the user.
    • name: The name of the user.
    • email: The email of the user.
    • password: The password of the user.
  • Remove(System.Guid)
    Remove the user.
    Parameters:
    • id: The id of the user.
  • GetById(System.Guid)
    Get the user by id.
    Parameters:
    • id: The id of the user.
    Returns:
    • The user entity.
  • GetAll()
    Get all the users.
    Returns:
    • The User entities.
Hexsoft.Knots.DataAccess.StepData
Represent the step data access.
Methods:
  • Add(System.Guid,System.String,System.String,System.Guid)
    Add the step.
    Parameters:
    • id: The id of the step.
    • type: The type of the step.
    • description: The description of the step.
    • knot: The knot of the step.
  • Set(System.Guid,System.String,System.String,System.Guid)
    Set the step.
    Parameters:
    • id: The id of the step.
    • type: The type of the step.
    • description: The description of the step.
    • knot: The knot of the step.
  • Remove(System.Guid)
    Remove the step.
    Parameters:
    • id: The id of the step.
  • RemoveByKnot(System.Guid)
    Remove the step by knot.
    Parameters:
    • knot: The knot of the step.
  • GetById(System.Guid)
    Get the step by id.
    Parameters:
    • id: The id of the step.
    Returns:
    • The step entity.
  • GetAll()
    Get all the steps.
    Returns:
    • The Step entities.
  • GetByKnot(System.Guid)
    Get the steps by knot.
    Parameters:
    • knot: The knot of the step.
    Returns:
    • The step entities.
Hexsoft.Knots.DataAccess.KnotData
Represent the knot data access.
Methods:
  • Add(System.Guid,System.String,System.String,System.Guid)
    Add the knot.
    Parameters:
    • id: The id of the knot.
    • name: The name of the knot.
    • description: The description of the knot.
    • user: The user of the knot.
  • Set(System.Guid,System.String,System.String,System.Guid)
    Set the knot.
    Parameters:
    • id: The id of the knot.
    • name: The name of the knot.
    • description: The description of the knot.
    • user: The user of the knot.
  • Remove(System.Guid)
    Remove the knot.
    Parameters:
    • id: The id of the knot.
  • RemoveByUser(System.Guid)
    Remove the knot by user.
    Parameters:
    • user: The user of the knot.
  • GetById(System.Guid)
    Get the knot by id.
    Parameters:
    • id: The id of the knot.
    Returns:
    • The knot entity.
  • GetAll()
    Get all the knots.
    Returns:
    • The Knot entities.
  • GetByUser(System.Guid)
    Get the knots by user.
    Parameters:
    • user: The user of the knot.
    Returns:
    • The knot entities.
Hexsoft.Knots.DataAccess.ClassificationData
Represent the classification data access.
Methods:
  • Add(System.Guid,System.Guid)
    Add the classification.
    Parameters:
    • knot: The knot of the classification.
    • category: The category of the classification.
  • Remove(System.Guid,System.Guid)
    Remove the classification.
    Parameters:
    • knot: The knot of the classification.
    • category: The category of the classification.
  • RemoveByKnot(System.Guid)
    Remove the classification by knot.
    Parameters:
    • knot: The knot of the classification.
  • RemoveByCategory(System.Guid)
    Remove the classification by category.
    Parameters:
    • category: The category of the classification.
  • GetAll()
    Get all the classifications.
    Returns:
    • The Classification entities.
  • GetByKnot(System.Guid)
    Get the classifications by knot.
    Parameters:
    • knot: The knot of the classification.
    Returns:
    • The classification entities.
  • GetByCategory(System.Guid)
    Get the classifications by category.
    Parameters:
    • category: The category of the classification.
    Returns:
    • The classification entities.
Hexsoft.Knots.DataAccess.LineData
Represent the line data access.
Methods:
  • Add(System.Guid,System.Guid,System.Int32)
    Add the line.
    Parameters:
    • id: The id of the object.
    • knot: The knot of the object.
    • material: The material of the line.
  • Set(System.Guid,System.Guid,System.Int32)
    Set the line.
    Parameters:
    • id: The id of the object.
    • knot: The knot of the object.
    • material: The material of the line.
  • Remove(System.Guid)
    Remove the line.
    Parameters:
    • id: The id of the line.
  • RemoveByKnot(System.Guid)
    Remove the line by knot.
    Parameters:
    • knot: The knot of the line.
  • GetById(System.Guid)
    Get the line by id.
    Parameters:
    • id: The id of the line.
    Returns:
    • The line entity.
  • GetAll()
    Get all the lines.
    Returns:
    • The Line entities.
  • GetByKnot(System.Guid)
    Get the lines by knot.
    Parameters:
    • knot: The knot of the line.
    Returns:
    • The line entities.
Hexsoft.Knots.DataAccess.CategoryData
Represent the category data access.
Methods:
  • Add(System.Guid,System.String)
    Add the category.
    Parameters:
    • id: The id of the category.
    • name: The name of the category.
  • Set(System.Guid,System.String)
    Set the category.
    Parameters:
    • id: The id of the category.
    • name: The name of the category.
  • Remove(System.Guid)
    Remove the category.
    Parameters:
    • id: The id of the category.
  • GetById(System.Guid)
    Get the category by id.
    Parameters:
    • id: The id of the category.
    Returns:
    • The category entity.
  • GetAll()
    Get all the categorys.
    Returns:
    • The Category entities.
Hexsoft.Knots.DataAccess.FixtureData
Represent the fixture data access.
Methods:
  • Add(System.Guid,System.Guid,System.Int32)
    Add the fixture.
    Parameters:
    • id: The id of the object.
    • knot: The knot of the object.
    • number: The number of the fixture.
  • Set(System.Guid,System.Guid,System.Int32)
    Set the fixture.
    Parameters:
    • id: The id of the object.
    • knot: The knot of the object.
    • number: The number of the fixture.
  • Remove(System.Guid)
    Remove the fixture.
    Parameters:
    • id: The id of the fixture.
  • RemoveByKnot(System.Guid)
    Remove the fixture by knot.
    Parameters:
    • knot: The knot of the fixture.
  • GetById(System.Guid)
    Get the fixture by id.
    Parameters:
    • id: The id of the fixture.
    Returns:
    • The fixture entity.
  • GetAll()
    Get all the fixtures.
    Returns:
    • The Fixture entities.
  • GetByKnot(System.Guid)
    Get the fixtures by knot.
    Parameters:
    • knot: The knot of the fixture.
    Returns:
    • The fixture entities.
Hexsoft.Knots.DataAccess.ObjectData
Represent the object data access.
Methods:
  • Add(System.Guid,System.Guid)
    Add the object.
    Parameters:
    • id: The id of the object.
    • knot: The knot of the object.
  • Set(System.Guid,System.Guid)
    Set the object.
    Parameters:
    • id: The id of the object.
    • knot: The knot of the object.
  • Remove(System.Guid)
    Remove the object.
    Parameters:
    • id: The id of the object.
  • RemoveByKnot(System.Guid)
    Remove the object by knot.
    Parameters:
    • knot: The knot of the object.
  • GetById(System.Guid)
    Get the object by id.
    Parameters:
    • id: The id of the object.
    Returns:
    • The object entity.
  • GetAll()
    Get all the objects.
    Returns:
    • The Object entities.
  • GetByKnot(System.Guid)
    Get the objects by knot.
    Parameters:
    • knot: The knot of the object.
    Returns:
    • The object entities.

Entity Prototype Description

Hexsoft.Knots.Entity.Object
Represent the object entity.
Properties:
  • Id
    Get or set the id of the object.
  • Knot
    Get or set the knot of the object.
Methods:
  • #ctor(System.Guid,Hexsoft.Knots.Entity.Knot)
    Initialize the object entity.
    Parameters:
    • id: The id of the object.
    • knot: The knot of the object.
Hexsoft.Knots.Entity.User
Represent the user entity.
Properties:
  • Id
    Get or set the id of the user.
  • Name
    Get or set the name of the user.
  • Email
    Get or set the email of the user.
  • Password
    Get or set the password of the user.
Methods:
  • #ctor(System.Guid,System.String,System.String,System.String)
    Initialize the user entity.
    Parameters:
    • id: The id of the user.
    • name: The name of the user.
    • email: The email of the user.
    • password: The password of the user.
Hexsoft.Knots.Entity.Step
Represent the step entity.
Properties:
  • Id
    Get or set the id of the step.
  • Type
    Get or set the type of the step.
  • Description
    Get or set the description of the step.
  • Knot
    Get or set the knot of the step.
Methods:
  • #ctor(System.Guid,System.String,System.String,Hexsoft.Knots.Entity.Knot)
    Initialize the step entity.
    Parameters:
    • id: The id of the step.
    • type: The type of the step.
    • description: The description of the step.
    • knot: The knot of the step.
Hexsoft.Knots.Entity.Category
Represent the category entity.
Properties:
  • Id
    Get or set the id of the category.
  • Name
    Get or set the name of the category.
Methods:
  • #ctor(System.Guid,System.String)
    Initialize the category entity.
    Parameters:
    • id: The id of the category.
    • name: The name of the category.
Hexsoft.Knots.Entity.Knot
Represent the knot entity.
Properties:
  • Id
    Get or set the id of the knot.
  • Name
    Get or set the name of the knot.
  • Description
    Get or set the description of the knot.
  • User
    Get or set the user of the knot.
Methods:
  • #ctor(System.Guid,System.String,System.String,Hexsoft.Knots.Entity.User)
    Initialize the knot entity.
    Parameters:
    • id: The id of the knot.
    • name: The name of the knot.
    • description: The description of the knot.
    • user: The user of the knot.
Hexsoft.Knots.Entity.Fixture
Represent the fixture entity.
Properties:
  • Number
    Get or set the number of the fixture.
Methods:
  • #ctor(System.Guid,Hexsoft.Knots.Entity.Knot,System.Int32)
    Initialize the fixture entity.
    Parameters:
    • id: The id of the object.
    • knot: The knot of the object.
    • number: The number of the fixture.
Hexsoft.Knots.Entity.Line
Represent the line entity.
Properties:
  • Material
    Get or set the material of the line.
Methods:
  • #ctor(System.Guid,Hexsoft.Knots.Entity.Knot,System.Int32)
    Initialize the line entity.
    Parameters:
    • id: The id of the object.
    • knot: The knot of the object.
    • material: The material of the line.
Hexsoft.Knots.Entity.Point
Represent the point entity.
Properties:
  • Id
    Get or set the id of the point.
  • Line
    Get or set the line of the point.
  • X
    Get or set the x of the point.
  • Y
    Get or set the y of the point.
  • Z
    Get or set the z of the point.
Methods:
  • #ctor(System.Guid,System.Int32,System.Int32,System.Int32,System.Int32)
    Initialize the point entity.
    Parameters:
    • id: The id of the point.
    • line: The line of the point.
    • x: The x of the point.
    • y: The y of the point.
    • z: The z of the point.
Hexsoft.Knots.Entity.Classification
Represent the classification entity.
Properties:
  • Knot
    Get or set the knot of the classification.
  • Category
    Get or set the category of the classification.
Methods:
  • #ctor(Hexsoft.Knots.Entity.Knot,Hexsoft.Knots.Entity.Category)
    Initialize the classification entity.
    Parameters:
    • knot: The knot of the classification.
    • category: The category of the classification.

General User Case

Editor User Case

Entity Definition Persisent with ER Diagram

Business Logic Prototypes

ER Diagram

Deploy Layout - 3 Phyiscal Tier

Atchitecture Released

3-Tier Architecture

Three-Tier is a clientserver architecture in which the user interface, functional process logic, computer data storage and data access are developed and maintained as independent modules, most often on separate platforms. It was developed by John J. Donovan in Open Environment Corporation, a tools company he founded in Cambridge, MA.
The three-tier model is software architecture and a software design pattern.
Apart from the usual advantages of modular software with well-defined interfaces, the three-tier architecture is intended to allow any of the three tiers to be upgraded or replaced independently as requirements or technology change. For example, a change of operating system in the presentation tier would only affect the user interface code.
Typically, the user interface runs on a desktop PC or workstation and uses a standard graphical user interface, functional process logic may consist of one or more separate modules running on a workstation or application server, and an RDBMS on a database server or mainframe contains the computer data storage logic. The middle tier may be multi-tiered itself.

Data Access Tier

This tier consists of database servers. Here information is stored and retrieved. This tier keeps data neutral and independent from application servers or business logic. Giving data its own tier also improves scalability and performance.

Business Logic Tier

The business logic tier is pulled out from the presentation tier and, as its own tier, it controls an applications functionality by performing detailed processing.

User Interface Tier

This is the topmost level of the application. The user interface tier displays information related to such services as browsing merchandise, purchasing, and shopping cart contents. It communicates with other tiers by outputting results to the browser/client tier and all other tiers in the network.

MVC Architecture

ModelViewController is a software architecture, currently considered an architectural pattern used in software engineering. The pattern isolates "domain logic" from input and presentation, permitting independent development, testing and maintenance of each.

Model

The model is used to manage information and notify observers when that information changes. The model is the domain-specific representation of the data upon which the application operates. Domain logic adds meaning to raw data. When a model changes its state, it notifies its associated views so they can be refreshed.

View

The view renders the model into a form suitable for interaction, typically a user interface element. Multiple views can exist for a single model for different purposes. A viewport typically has a one to one correspondence with a display surface and knows how to render to it.

Controller

The controller receives input and initiates a response by making calls on model objects. A controller accepts input from the user and instructs the model and viewport to perform actions based on that input.

Client Server Architecture

The clientserver model of computing is a distributed application structure that partitions tasks or workloads between the providers of a resource or service, called servers, and service requesters, called clients. Often clients and servers communicate over a computer network on separate hardware, but both client and server may reside in the same system. A server machine is a host that is running one or more server programs which share their resources with clients. A client does not share any of its resources, but requests a server's content or service function. Clients therefore initiate communication sessions with servers which await incoming requests.

Database Server

A database server is a computer program that provides database services to other computer programs or computers, as defined by the clientserver model. The term may also refer to a computer dedicated to running such a program. Database management systems frequently provide database server functionality, and some DBMSs rely exclusively on the clientserver model for database access.

Application Server

An application server is a software framework dedicated to the efficient execution of procedures for supporting the construction of applications. The term was originally used when discussing early clientserver systems and servers that run SQL services and middleware servers to differentiate them from file servers.

Client

A client is an application or system that accesses a remote service on another computer system, known as a server, by way of a network. The term was first applied to devices that were not capable of running their own stand-alone programs, but could interact with remote computers via a network. These dumb terminals were clients of the time-sharing mainframe computer.

Monday, August 30, 2010

Base on the discuses of the meeting in Friday, I update the entity modeling which Tim already post once before. Thanks.
This is Draft version of use case, I hope everyone could helps to add basic functionality to it, it will helps us to finish the user manual, Thanks.