Configuration Reference generated doc: bug fix: hidden relations not handl...

jcambon

25.24.2008 9643d50e30607cbffc4b1cbab860c9421608b40f

Configuration Reference generated doc:
bug fix:
 hidden relations not handled correctly in the "Relations to this component" and "Relation from this component" section 
 (e.g. for "Root DN", "Root DN user" should not appear).

 opends/src/server/org/opends/server/admin/doc/ConfigGuideGeneration.java

@@ -454,13 +454,24 @@

    // Relations
    if (!mo.getRelationDefinitions().isEmpty()) {
      boolean emptyList = true;
      @SuppressWarnings("unchecked")
      Collection<RelationDefinition> rels = mo.getRelationDefinitions();
      for ( RelationDefinition rel : rels) {
        if (rel.hasOption(RelationOption.HIDDEN)) {
          continue;
        }
        emptyList = false;
      }
      if (!emptyList) {
      heading3("Relations From this Component");
      paragraph(
        "The following components have a direct composition relation FROM " +
        mo.getUserFriendlyPluralName() + " :");
      @SuppressWarnings("unchecked")
      Collection<RelationDefinition> rels = mo.getRelationDefinitions();
      for ( RelationDefinition rel : rels) {
          if (rel.hasOption(RelationOption.HIDDEN)) {
            continue;
          }
        beginList();
        AbstractManagedObjectDefinition childRel = rel.getChildDefinition();
        link(childRel.getUserFriendlyName().toString(), childRel.getName() +
@@ -468,17 +479,23 @@
        endList();
      }
    }
    }

    if (!mo.getReverseRelationDefinitions().isEmpty()) {
      boolean isRoot = false;
      boolean emptyList = true;
      @SuppressWarnings("unchecked")
      Collection<RelationDefinition> rels = mo.getReverseRelationDefinitions();
      for ( RelationDefinition rel : rels) {
        // only check if it is not root
        if (rel.hasOption(RelationOption.HIDDEN)) {
          continue;
        }
        // check if it is not root
        if (rel.getParentDefinition().getName().equals("")) {
          isRoot = true;
          continue;
        }
        emptyList = false;
      }
      if (!isRoot) {
      if (!emptyList) {
        heading3("Relations To this Component");
        paragraph(
          "The following components have a direct composition relation TO " +

 opends/src/server/org/opends/server/admin/doc/package-info.java

@@ -30,7 +30,7 @@
/**
 * Common administration classes.
 * <p>
 * This package contains the generation of the Configuretion Guide
 * This package contains the generation of the Configuration Guide
 * common to both the client and server.
 */
@org.opends.server.types.PublicAPI(