[brailleblaster] Re: Putative Java tree for BrailleBlaster

  • From: Chris von See <chris@xxxxxxxxxxxxx>
  • To: brailleblaster@xxxxxxxxxxxxx
  • Date: Mon, 22 Nov 2010 17:03:44 -0800

The top-level directory of the Maven source bundle contains a Maven POM that is the top-level POM for Maven itself. That POM points to a number of sub-projects (listed in the <modules> section of the POM), and each of those sub-projects has its own sub-directory under the top- level directory. Each sub-project has a POM and a directory structure that conforms to the Maven recommendations. For example, the "maven- core" subproject has its source in a directory called "src/main/java", its core resources in a directory called "src/main/resources", its test classes in "src/test/java", and so on. There's other miscellaneous junk in the maven directories - readme files, etc. - that can be ignored when looking at the directory structure.


If that's not what you're seeing, then I'm not sure what's going on.


Cheers
Chris



On Nov 22, 2010, at 3:48 PM, John J. Boyer wrote:

I downloaded the Maven source, butg it doesn't look much like the
directory layout described in the other link. what's going on?

Thanks,
John

On Mon, Nov 22, 2010 at 02:54:24PM -0800, Chris von See wrote:
Maven itself conforms to Maven :)  You can download the most recent
sources here:

http://www.apache.org/dyn/closer.cgi/maven/source/apache-maven-3.0-src.zip

Keep in mind that Maven (like many other Maven-based projects) is made up of many subprojects, each of which has a Maven-conformant directory
tree.

The directory structure is somewhat flexible, but there are some parts
(such as the ones I mentioned earlier) that are better left as Maven
expects them... otherwise Maven gets quite confused and you end up
chasing your tail trying to figure out what's wrong.

The "site" is simply the documentation web site that can be generated
by Maven.  You may find these links helpful in explaining things such
as the Maven "site":

http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html
http://maven.apache.org/guides/getting-started/index.html


Cheers
Chris


On Nov 22, 2010, at 2:40 PM, John J. Boyer wrote:

Chris,

I downloaded tika some time ago and built it with Maven. However, its directory tree doesn't lok much like the recommended Maven one. Could you point me to a project that conforms to Maven? The directory layout
given in the linked page is rather brief. What are assembly
descriptors
and filter files? What is the Site?

Thanks,
John

On Mon, Nov 22, 2010 at 12:10:39PM -0800, Chris von See wrote:
If you're still thinking that you'll use Maven for build and
dependency management, you'll want to make your directory tree
conform
to Maven rules.  For example, the Java source is stored in a "src/
main/
java" directory and test cases are stored in a "src/test/java"
directory.  The results of the build process are typically stored
in a
"target" directory which is at the same level in the tree as the
"src"
directory, and libraries go into "src/main/resources".

Here's a link to a description of Maven's standard directory layout:
http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html

Cheers
Chris



On Nov 22, 2010, at 11:26 AM, John J. Boyer wrote:

I've started to build a putative Java tree for BrailleBlaster,
partly
because I feel that we are ready for such an attempt and partly to
learn
by doing. So far I have a bin subdirectory for compiled classes, a
lib
subdirectory for jar files and a few classes from elsewhere, and a
src
subdirectory. Both the bin and src subdirectories are proper Java
hierarchies.

Under src/org/brailleblaster I have the following packages: startbb liblouisutdml and editor The first contains the StartBB class, which
contains the main method and gets everything ready to run. It may
have
other classes as time goes on. The liblouisutdml package contains
classes for dealing with the liblouisutdml library, such as
converting
its input and output from and to JDOM documents and handling errors
reported in the log file.

The editor package contains the classes Editor, DaisyWindow and
BrailleWindow. Other classes will be added, such as Commons to
handle
operations common to the two windows. A method in the Editor class
is
called from the StartBB class to start the editor. This Editor class
is
the Control in MVC. The two window classes are the view. The Commons
class is the model.

The editor's basic function is to display JDOM documents and trees
and
to modify them according to user input. Producing them and
generating
various types of output from them is the job of other packages.
Besides
this basic function, the edotor also acts as the general user
interface. It therefore displays dialogue boxes and menus that are
actually produced by other packages, such as the help package, which
has
yet to be added.

At some time I may want to push this tree to the project repository,
but
I don't seem to have a password.

At present the lib subdirectory contains jdom.jar swt.jar and
Jliblouisutdml.class Jeuclid.jar will be added later, as will jar
files
containing classes to deal with other C libraries, such as
itex2mml.jar
and hunspell.jar

All right, maybe I'm making a fool of myself again, but this is a
start.

John

--
John J. Boyer; President, Chief Software Developer
Abilitiessoft, Inc.
http://www.abilitiessoft.com
Madison, Wisconsin USA
Developing software for people with disabilities




--
John J. Boyer; President, Chief Software Developer
Abilitiessoft, Inc.
http://www.abilitiessoft.com
Madison, Wisconsin USA
Developing software for people with disabilities




--
John J. Boyer; President, Chief Software Developer
Abilitiessoft, Inc.
http://www.abilitiessoft.com
Madison, Wisconsin USA
Developing software for people with disabilities




Other related posts: