[richfaces-issues] [JBoss JIRA] (RF-13480) Java package re-structure for the photoalbum demo

Lukáš Fryč (JIRA) issues at jboss.org
Wed Jan 15 06:55:33 EST 2014


    [ https://issues.jboss.org/browse/RF-13480?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12935862#comment-12935862 ] 

Lukáš Fryč commented on RF-13480:
---------------------------------

If we get inspired by quickstarts [1]:

1) `UserBean` should be called just `User` and be in `model` package

* managed beans for view layer should be called `controllers` (spring mvc terminology), they are usually usually CDI beans annotated with @Model (that is in turn an @Named @RequestScoped stereotype
* JPA repositories (classes manipulating with JPA/entities or other data) are in `data` package

I don't think this is something strict, but consistency may help and quickstarts went through detailed review process.

[1] https://github.com/jboss-developer/jboss-eap-quickstarts/tree/master/kitchensink/src/main/java/org/jboss/as/quickstarts/kitchensink
                
> Java package re-structure for the photoalbum demo
> -------------------------------------------------
>
>                 Key: RF-13480
>                 URL: https://issues.jboss.org/browse/RF-13480
>             Project: RichFaces
>          Issue Type: Enhancement
>      Security Level: Public(Everyone can see) 
>          Components: examples
>            Reporter: Brian Leathem
>            Assignee: Michal Petrov
>              Labels: photoalbum
>             Fix For: 4.3.5
>
>   Original Estimate: 2 hours
>  Remaining Estimate: 2 hours
>
> This issue addresses the cleanup of the java package namespace of the demo.
> 1) The package _org.richfaces.photoalbum.bean_ contains the single class _UserBean_.  Let's rename the package to something less generic like _user_ or consider merging it into another pre-existing package like _ui_.
> 2) The _event_ package is separate from the _domain_ package.  Let's consider moving the _event_ package to be a sub-package of _domain_.  While we are at it, I find the package name _model_ to be more descriptive than _domain_.
> 3) The _services_ package may be better described as an _actions_ package.
> 4) The _util_ package is too generic.  Consider creating _converters_ and _validators_ packages to hold the bulk of these classes.  Additionally the classnames _*Stuff_ and _Utils_ could be named less generically.
> 5) having the two top-level classes _search_ and _ejbsearch_ is confusing.  Can one package be a sub-folder of the other?  Alternatively could one be in the _ui_ folder, or the other in a _model_ folder?

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira



More information about the richfaces-issues mailing list