Organize schema description parsers and value objects
-----------------------------------------------------

                 Key: DIRSHARED-23
                 URL: https://issues.apache.org/jira/browse/DIRSHARED-23
             Project: Directory Shared
          Issue Type: Improvement
    Affects Versions: 0.9.13
            Reporter: Alex Karasulu
            Priority: Minor
             Fix For: 0.9.15


Currently we have the following subpackages under 
org.apache.directory.shared.ldap.schema:

  - comparator
  - parser
  - syntax
  - syntax.parser


--------------------------------------
Per Package Breakdown
--------------------------------------

Package:  
   org.apache.directory.shared.ldap.schema

At the schema package level you'll find the interfaces and some abstract/base 
implementations for the various kinds of schema entities like Syntax, 
AttributeType, MatchingRule, ObjectClass etc.  Included are also some basic 
Normalizer implementations which should be moved into a normalizer subpackage.

Package:  
   org.apache.directory.shared.ldap.schema.comparator

This one seems to match it's purpose and it contains some comparator 
implementations. If anything needs to be done this should be renamed to 
comparators since it will contain many comparators.

Package:  
   org.apache.directory.shared.ldap.schema.parser

This package contains an older parser written ages ago to read schema files.  I 
don't know if it is still in use but we have to check this and if so delete the 
classes contained in there.  If the parser is in use this package should be 
renamed to parsers instead and other parsers for schema entities should be 
moved there.

Package:  
   org.apache.directory.shared.ldap.schema.syntax

This package contains common syntax implementations as one would intuit from 
the name. If anything it's name should be changed to pluralize what it 
contains: syntaxes. 

Package:  
   org.apache.directory.shared.ldap.schema.syntax.parser

This package contains a number of different parsers.  Not just the parser for 
syntax descriptions but for all kinds of schema entities.  It's contents should 
be in the org.apache.directory.shared.ldap.schema.parsers package.

NOTE: Some utility classes exist as well and these can be stored in a utils 
package under schema. Any other schema entity implementations should fall under 
their respective package names even if there's a single implementation class.


-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply via email to