Parancoe Guidelines

Do we really need Parancoe? Which technologies does it use and why? What are the shared ideas behind it?

Motivations

The decision of developing Parancoe comes from the observation that most (if not all) of the Java Web frameworks require too long development time, even for a very simple Web application. We think that the main reason for this fact is that these frameworks are developed for covering all use-cases and problems of any web application. So the main concerns are the flexibility and configurability, not the easiness, the speed and the joy of development. But the use-cases that you can find in the all-days work are relatively few and simple. Again we are using a big heavy bazooka when a small, simple and economic sling would suffit.

The purpose of Parancoe is to cover the use-cases of a common Web application for developing them in the simplest and most rapid possible manner.

Development Guidelines

Prefer convention over configuration.

Basically for using you shouldn’t need to write configuration files. The only possibly complex configuration files should be those necessary for the Parancoe implementation, that the user (i.e. the programmer developing the Web application) shouldn’t never need to modify. Other configurations should remain simple and minimal: the default value usually is the needed value.

Don’t Repeat Yoursef (DRY) principle.

The user don’t have to write the same information more than one single time.

Speaking URLs.

URLs should be easy to read.

Source Code Conventions

  • Text encoding is UTF-8
  • Source code style is sun’s standard conventions
  • Interface/Class naming convention. The name of the interface must be the more expressive name, without any prefix marking it’s an interface. So, don’t use IBean, but simply Bean. The name of the class implementing an interface should be <InterfaceName>DefaultImpl, or simply <InterfaceName>Impl. For example: BeanImpl.

Adopted Technologies

Posted by Lucio Benfante on Saturday, June 10, 2006