jsr-283
  1. jsr-283
  2. JSR_283-786

Sync Column specification with JavaDoc

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: current
    • Fix Version/s: milestone 1
    • Component/s: spec
    • Labels:
      None
    • Environment:

      Operating System: All
      Platform: All

    • Issuezilla Id:
      786

      Description

      There are some inconsistencies between the specification for the QOM Column and
      the respective JavaDoc.

      The specification says:

      The query is invalid if:

      • selectorName is not the name of a selector in the query, or
      • propertyName is specified but does not evaluate to a scalar value, or
      • propertyName is specified but columnName is omitted, or
      • propertyName is omitted but columnName is specified, or
      • the columns in the tabular view are not uniquely named, whether those column names are specified
        by columnName (if propertyName is specified) or generated as described above (if propertyName is
        omitted).

      whereas JavaDoc says:

      The query is invalid if:

      • selector is not the name of a selector in the query, or
      • property is specified but it is not a syntactically valid JCR name, or
      • property is specified but does not evaluate to a scalar value, or
      • property is specified but columnName is omitted, or
      • property is omitted but columnName is specified, or
      • the columns in the tabular view are not uniquely named, whether those column names are specified
        by columnName (if property is specified) or generated as described above (if property is omitted).

      Furthermore, the JavaDoc for the parameter columnName is IMO wrong:

      columnName - the column name; if null, defaults to propertyName; must be null if propertyName is
      null

      I think it should rather say:

      columnName - the column name; must be null if propertyName is null; must be non-null if
      propertyName is non-null.

        Activity

        Hide
        Peeter Piegaze added a comment -

        Fixed: Javadoc fixed by renaming param names properly and removing reference to error on invalid JCR
        name (this case is already covered by error on failure to evaluate to scalar). Columnname javadoc also
        corrected

        Show
        Peeter Piegaze added a comment - Fixed: Javadoc fixed by renaming param names properly and removing reference to error on invalid JCR name (this case is already covered by error on failure to evaluate to scalar). Columnname javadoc also corrected

          People

          • Assignee:
            jsr-283-issues
            Reporter:
            mreutegg
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: