Skip to content

Commit

Permalink
MONDRIAN: Undoing some JavaDoc new line to "</p>" changes probably in…
Browse files Browse the repository at this point in the history 
…troduced by new Intellij version 7

[git-p4: depot-paths = "//open/mondrian/": change = 10285]
  • Loading branch information
Ajit Joglekar committed Dec 13, 2007
1 parent 7599d71 commit 4166c09
Showing 1 changed file with 51 additions and 52 deletions.
103 changes: 51 additions & 52 deletions src/main/mondrian/olap/MondrianProperties.java
View file
Expand Up @@ -30,27 +30,27 @@
/**
* <code>MondrianProperties</code> contains the properties which determine the
* behavior of a mondrian instance.
* <p/>
*
* <p>There is a method for property valid in a
* <code>mondrian.properties</code> file. Although it is possible to retrieve
* properties using the inherited {@link Properties#getProperty(String)}
* method, we recommend that you use methods in this class.
* <p/>
*
* <h2>Note to developers</h2>
* <p/>
*
* If you add a property, you must:<ul>
* <p/>
*
* <li>Add a property definition to this class</li>
* <p/>
*
* <li>Modify the default <code>mondrian.properties</code> file checked into
* source control, with a description of the property and its default
* value.</li>
* <p/>
*
* <li>Modify the
* <a target="_top" href="{@docRoot}/../configuration.html#Property_list">
* Configuration Specification</a>.</li>
* </ul>
* <p/>
*
* <p>Similarly if you update or delete a property.
*
* @author jhyde
Expand Down Expand Up @@ -100,7 +100,7 @@ public boolean triggersAreEnabled() {
public interface PropertySource {
/**
* Opens an input stream from the source.
* <p/>
*
* <p>Also checks the 'last modified' time, which will determine whether
* {@link #isStale()} returns true.
*
Expand Down Expand Up @@ -303,7 +303,7 @@ private void load(final PropertySource source) {

/**
* Returns a list of every {@link org.eigenbase.util.property.Property}.
* <p/>
*
* <p>todo: Move to base class, {@link TriggerableProperties}, and rename
* base method {@link TriggerableProperties#getProperties()}}.
*
Expand Down Expand Up @@ -331,7 +331,7 @@ public List<Property> getPropertyList() {
/**
* Returns the definition of a named property, or null if there is no
* such property.
* <p/>
*
* <p>todo: Move to base class, {@link TriggerableProperties}.
*
* @param path Name of the property
Expand All @@ -350,7 +350,7 @@ public Property getPropertyDefinition(String path) {

/**
* Maximum number of simultaneous queries the system will allow.
* <p/>
*
* <p>Oracle fails if you try to run more than the 'processes' parameter in
* init.ora, typically 150. The throughput of Oracle and other databases
* will probably reduce long before you get to their limit.</p>
Expand All @@ -360,7 +360,7 @@ public Property getPropertyDefinition(String path) {

/**
* Property which controls the amount of tracing displayed.
* <p/>
*
* <p>If trace level is above 0, SQL tracing will be enabled and logged as
* per the <code>{@link #DebugOutFile mondrian.debug.out.file}</code>
* property below. This is separate from Log4j logging.
Expand Down Expand Up @@ -435,10 +435,9 @@ public Property getPropertyDefinition(String path) {
* This is the name of the class which either implements
* <code>junit.framework.Test</code> or has a method
* <code>public [static] junit.framework.Test suite()</code>.
* <p/>
*
* <p>Example:
* <blockquote><code>mondrian.test.Class=mondrian.test.FoodMartTestCase</code></blockquote>
* </p>
*
* @see #TestName
*/
Expand Down Expand Up @@ -498,18 +497,18 @@ public Property getPropertyDefinition(String path) {
* Property which, with {@link #SparseSegmentDensityThreshold}, determines
* whether to choose a sparse or dense representation when storing
* collections of cell values in memory.
* <p/>
*
* <p>When storing collections of cell values, Mondrian has to choose
* between a sparse and a dense representation, based upon the
* <code>possible</code> and <code>actual</code> number of values.
* The <code>density</code> is <code>actual / possible</code>.
* <p/>
*
* <p>We use a sparse representation if
* <code>(possible -
* {@link #SparseSegmentCountThreshold countThreshold}) *
* {@link #SparseSegmentDensityThreshold densityThreshold} &gt;
* actual</code>
* <p/>
*
* <p>For example, at the default values
* ({@link #SparseSegmentCountThreshold countThreshold} = 1000,
* {@link #SparseSegmentDensityThreshold} = 0.5),
Expand Down Expand Up @@ -539,10 +538,10 @@ public Property getPropertyDefinition(String path) {
* a pattern for which test XML files to run. Pattern has to
* match a file name of the form:
* <code>query<i>whatever</i>.xml</code> in the directory.
* <p/>
*
* <p>Example:
* <blockquote><code>mondrian.test.QueryFilePattern=queryTest_fec[A-Za-z0-9_]*.xml</code></blockquote>
* </p>
*
*/
public transient final StringProperty QueryFilePattern =
new StringProperty(
Expand Down Expand Up @@ -626,11 +625,11 @@ public Property getPropertyDefinition(String path) {

/**
* Boolean property that controls whether Mondrian uses aggregate tables.
* <p/>
*
* <p>If true, then Mondrian uses aggregate tables. This property is
* queried prior to each aggregate query so that changing the value of this
* property dynamically (not just at startup) is meaningful.
* <p/>
*
* <p>Aggregates can be read from the database using the
* {@link #ReadAggregates} property but will not be used unless this
* property is set to true.
Expand All @@ -642,7 +641,7 @@ public Property getPropertyDefinition(String path) {
/**
* Boolean property which determines whether Mondrian should read aggregate
* tables.
* <p/>
*
* <p>If set to true, then Mondrian scans the database for aggregate tables.
* Unless mondrian.rolap.aggregates.Use is set to true, the aggregates
* found will not be used.
Expand All @@ -655,7 +654,7 @@ public Property getPropertyDefinition(String path) {
/**
* Boolean property that controls whether aggregate tables
* are ordered by their volume or row count.
* <p/>
*
* <p>If true, Mondrian uses the aggregate table with the smallest volume
* (number of rows multiplied by number of columns); if false, Mondrian
* uses the aggregate table with the fewest rows.
Expand All @@ -668,10 +667,10 @@ public Property getPropertyDefinition(String path) {
* String property containing the name of the file which defines the rules
* for recognizing an aggregate table. Can be either a resource in the
* Mondrian jar or a URL.
* <p/>
*
* <p>The default value is "/DefaultRules.xml", which is in the
* mondrian.rolap.aggmatcher package in Mondrian.jar.
* <p/>
*
* <p>Normally, this property is not set by a user.
*/
public transient final StringProperty AggregateRules =
Expand All @@ -680,7 +679,7 @@ public Property getPropertyDefinition(String path) {

/**
* String property which is the AggRule element's tag value.
* <p/>
*
* <p>Normally, this property is not set by a user.
*/
public transient final StringProperty AggregateRuleTag =
Expand All @@ -690,7 +689,7 @@ public Property getPropertyDefinition(String path) {
/**
* Boolean property which controls whether to print the SQL code
* generated for aggregate tables.
* <p/>
*
* <p>If set, then as each aggregate request is processed, both the lost
* and collapsed dimension create and insert sql code is printed.
* This is for use in the CmdRunner allowing one to create aggregate table
Expand All @@ -716,7 +715,7 @@ public Property getPropertyDefinition(String path) {
/**
* Boolean property that controls whether to notify the Mondrian system
* when a {@link MondrianProperties property value} changes.
* <p/>
*
* <p>This allows objects dependent on Mondrian properties to react (that
* is, reload), when a given property changes via, say,
* <code>MondrianProperties.instance().populate(null)</code> or
Expand Down Expand Up @@ -774,12 +773,12 @@ public Property getPropertyDefinition(String path) {
/**
* Integer property which controls whether to test operators' dependencies,
* and how much time to spend doing it.
* <p/>
*
* <p>If this property is positive, Mondrian's test framework allocates an
* expression evaluator which evaluates each expression several times, and
* makes sure that the results of the expression are independent of
* dimensions which the expression claims to be independent of.
* <p/>
*
* <p>The default is 0.
*/
public transient final IntegerProperty TestExpDependencies =
Expand All @@ -788,16 +787,16 @@ public Property getPropertyDefinition(String path) {

/**
* Seed for random number generator used by some of the tests.
* <p/>
* <p/>
*
*
* Any value besides 0 or -1 gives deterministic behavior.
* The default value is 1234: most users should use this.
* Setting the seed to a different value can increase coverage, and
* therefore may uncover new bugs.
* <p/>
*
* <p>If you set the value to 0, the system will generate its own
* pseudo-random seed.
* <p/>
*
* <p>If you set the value to -1, Mondrian uses the next seed from an
* internal random-number generator. This is a little more deterministic
* than setting the value to 0.
Expand All @@ -808,11 +807,11 @@ public Property getPropertyDefinition(String path) {

/**
* Name of locale property file.
* <p/>
*
* <p>Used for the {@link mondrian.i18n.LocalizingDynamicSchemaProcessor};
* see <a href="{@docRoot}/../schema.html#I18n">Internationalization</a>
* for more details.</td>
* <p/>
*
* <p>Default value is null.
*/
public transient final StringProperty LocalePropFile =
Expand Down Expand Up @@ -853,21 +852,21 @@ public Property getPropertyDefinition(String path) {
* enabled but not supported for that function's usage in a particular
* query. (No alert is ever raised in cases where native evaluation would
* definitely have been wasted effort.)
* <p/>
* <p/>
* <p/>
*
*
*
* Recognized actions:
* <p/>
*
* <ul>
* <p/>
*
* <li><code>OFF</code>: do nothing (default action, also used if
* unrecognized action is specified)
* <p/>
*
* <li><code>WARN</code>: log a warning to RolapUtil logger
* <p/>
*
* <li><code>ERROR</code>: throw an instance of
* {@link NativeEvaluationUnsupportedException}
* <p/>
*
* </ul>
*/
public transient final StringProperty AlertNativeEvaluationUnsupported =
Expand Down Expand Up @@ -899,11 +898,11 @@ public Property getPropertyDefinition(String path) {

/**
* Max number of constraints in a single `IN' SQL clause.
* <p/>
*
* <p>This value may be variant among database prodcuts and their runtime
* settings. Oracle, for example, gives the error "ORA-01795: maximum
* number of expressions in a list is 1000".
* <p/>
*
* <p>Recommended values:<ul>
* <li>Oracle: 1,000
* <li>DB2: 2,500
Expand All @@ -923,7 +922,7 @@ public Property getPropertyDefinition(String path) {
/**
* Property which defines the
* maximum number of passes allowable while evaluating an MDX expression.
* <p/>
*
* <p>If evaluation exceeds this depth (for example, while evaluating a
* very complex calculated member), Mondrian will throw an error.
*/
Expand Down Expand Up @@ -1000,7 +999,7 @@ public Property getPropertyDefinition(String path) {
/**
* Property which defines
* the name of the class used as a memory monitor.
* <p/>
*
* <p>If the value is
* non-null, it is used by the <code>MemoryMonitorFactory</code>
* to create the implementation.
Expand All @@ -1012,7 +1011,7 @@ public Property getPropertyDefinition(String path) {
/**
* Property which defines
* the name of the class used to compile scalar expressions.
* <p/>
*
* <p>If the value is
* non-null, it is used by the <code>ExpCompiler.Factory</code>
* to create the implementation.
Expand All @@ -1023,7 +1022,7 @@ public Property getPropertyDefinition(String path) {
/**
* Property which defines
* when to apply the crossjoin optimization algorithm.
* <p/>
*
* <p>If a crossjoin input list's size is larger than this property's
* value and the axis has the "NON EMPTY" qualifier, then
* the crossjoin non-empty optimizer is applied.
Expand All @@ -1040,7 +1039,7 @@ public Property getPropertyDefinition(String path) {
/**
* Property which defines
* the behavior of division if the denominator evaluates to zero.
* <p/>
*
* <p>If a division has a non-null numerator and a null denominator,
* it evaluates to "Infinity", which conforms to MSAS behavior. However,
* the old semantics of evaluating this to NULL (non MSAS-conforming), is
Expand All @@ -1055,7 +1054,7 @@ public Property getPropertyDefinition(String path) {
* Property which defines
* whether to generate SQL queries using the <code>GROUPING SETS</code>
* construct for rollup. By default it is not enabled.
* <p/>
*
* <p>Ignored on databases which do not support the
* <code>GROUPING SETS</code> construct (see
* {@link mondrian.rolap.sql.SqlQuery.Dialect#supportsGroupingSets}).
Expand Down

0 comments on commit 4166c09

Please sign in to comment.