You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by hu...@apache.org on 2005/06/15 21:03:44 UTC
svn commit: r190791 - in /struts/sandbox/trunk/overdrive/Nexus: Core/
Core/Helpers/ Core/Tables/ Core/Validators/ Test/ Web/
Author: husted
Date: Wed Jun 15 12:03:43 2005
New Revision: 190791
URL: http://svn.apache.org/viewcvs?rev=190791&view=rev
Log:
OVR-15
* NDoc changes only.
Modified:
struts/sandbox/trunk/overdrive/Nexus/Core/Core.csproj
struts/sandbox/trunk/overdrive/Nexus/Core/Helpers/IViewHelper.cs
struts/sandbox/trunk/overdrive/Nexus/Core/IRequestChain.cs
struts/sandbox/trunk/overdrive/Nexus/Core/IRequestCommand.cs
struts/sandbox/trunk/overdrive/Nexus/Core/IRequestContext.cs
struts/sandbox/trunk/overdrive/Nexus/Core/Tables/IFieldTable.cs
struts/sandbox/trunk/overdrive/Nexus/Core/Tokens.cs
struts/sandbox/trunk/overdrive/Nexus/Core/Validators/IValidator.cs
struts/sandbox/trunk/overdrive/Nexus/Core/Validators/Validator.cs
struts/sandbox/trunk/overdrive/Nexus/Core/Validators/ValidatorContext.cs
struts/sandbox/trunk/overdrive/Nexus/Test/Test.csproj
struts/sandbox/trunk/overdrive/Nexus/Web/Web.csproj
Modified: struts/sandbox/trunk/overdrive/Nexus/Core/Core.csproj
URL: http://svn.apache.org/viewcvs/struts/sandbox/trunk/overdrive/Nexus/Core/Core.csproj?rev=190791&r1=190790&r2=190791&view=diff
==============================================================================
--- struts/sandbox/trunk/overdrive/Nexus/Core/Core.csproj (original)
+++ struts/sandbox/trunk/overdrive/Nexus/Core/Core.csproj Wed Jun 15 12:03:43 2005
@@ -29,7 +29,7 @@
CheckForOverflowUnderflow = "false"
ConfigurationOverrideFile = ""
DefineConstants = "DEBUG;TRACE"
- DocumentationFile = ""
+ DocumentationFile = "Agility.Core"
DebugSymbols = "true"
FileAlignment = "4096"
IncrementalBuild = "false"
Modified: struts/sandbox/trunk/overdrive/Nexus/Core/Helpers/IViewHelper.cs
URL: http://svn.apache.org/viewcvs/struts/sandbox/trunk/overdrive/Nexus/Core/Helpers/IViewHelper.cs?rev=190791&r1=190790&r2=190791&view=diff
==============================================================================
--- struts/sandbox/trunk/overdrive/Nexus/Core/Helpers/IViewHelper.cs (original)
+++ struts/sandbox/trunk/overdrive/Nexus/Core/Helpers/IViewHelper.cs Wed Jun 15 12:03:43 2005
@@ -20,7 +20,7 @@
namespace Nexus.Core.Helpers
{
/// <summary>
- /// A facade for use by a code-behind to simplify access to the
+ /// Provide a facade for use by a code-behind to simplify access to the
/// IRequestContext and IRequestCommand.
/// </summary>
/// <remarks><p>
@@ -89,7 +89,7 @@
// ----
/// <summary>
- /// A list of alert (or error) messages,
+ /// Record a list of alert (or error) messages,
/// keyed by the field causing the message,
/// or to a magic global key.
/// </summary>
@@ -98,7 +98,7 @@
/// <summary>
- /// Return true if alerts are queued.
+ /// Indicate if alerts are queued.
/// </summary>
/// <returns>True if alerts are queued.</returns>
///
@@ -106,21 +106,21 @@
/// <summary>
- /// An Exception, if thrown.
+ /// Record an Exception, if thrown.
/// </summary>
///
Exception Fault { get; }
/// <summary>
- /// Return true if an exception is caught.
+ /// Indicate whether an Exception is caught.
/// </summary>
- /// <returns>True if an exception is caught.</returns>
+ /// <returns>True if an Exception is caught.</returns>
///
bool HasFault { get; }
/// <summary>
- /// Return true if there are no alerts or fault pending.
+ /// Indicate if there are no alerts or fault pending.
/// </summary>
/// <returns>True if all is well.</returns>
///
@@ -128,7 +128,7 @@
/// <summary>
- /// A list of hint (or advisory) messages,
+ /// Record a list of hint (or advisory) messages,
/// keyed by a field or other identifier,
/// or to a magic global key.
/// </summary>
@@ -137,7 +137,7 @@
/// <summary>
- /// Return true if Hints are queued.
+ /// Indicate if Hints are queued.
/// </summary>
/// <returns>True if Hints are queued.</returns>
///
@@ -147,24 +147,24 @@
// ----
/// <summary>
- /// Set of IFieldContext definitions available to the application,
- /// usually set by the catalog.
+ /// Provide the Field Table for this Helper.
/// </summary>
/// <remarks><p>
- /// The FieldTable can be used to convert display strings to native
- /// types on input,
- /// and from native types to display strings on output.
- /// The FieldTable can also be used to generate UI controls.
+ /// The default implementation uses the Catalog to inject the global
+ /// Field Table reference.
+ /// The Context, and members with access to a Context,
+ /// can use the FieldTable to validate and format values,
+ /// and even to create controls that display values.
/// </p></remarks>
///
IFieldTable FieldTable { get; }
/// <summary>
- /// Set of IFieldContext definitions to be used with this helper,
- /// usually set by dependency injection.
+ /// Provide a set of IFieldContext definitions to be used with this helper.
/// </summary>
/// <remarks><p>
+ /// The FieldSet is usually set by dependency injection.
/// Some helpers generate DataGrids or DataForms based on the
/// FieldDefinitions
/// </p></remarks>
@@ -181,21 +181,20 @@
// ----
/// <summary>
- /// Prefix to trim from the id of a control during Read and
+ /// Provide a prefix to trim from the id of a control during Read and
/// Bind.
/// </summary>
/// <remarks><p>
/// The Prefix is needed when a single page uses a control
- /// more than once
- /// often in separate panels.
+ /// more than once often in separate panels.
/// </p></remarks>
///
string Prefix { get; set; }
/// <summary>
- /// Suffix to truncate from a list control id in order to set a
- /// corresponding value field ["_list"].
+ /// Provide a suffix to truncate from a list control id
+ /// in order to set a corresponding value field ["_list"].
/// </summary>
/// <remark><p>
/// When processing a single-value list control, if the id ends with
@@ -218,15 +217,20 @@
/// <summary>
- /// If a control value is an empty string, set the value to null
- /// instead [TRUE].
+ /// Indicate whether to set the value read from control to null
+ /// if it is an empty string [TRUE].
/// </summary>
+ /// <remarks><p>
+ /// If a control is blank, it may still return an empty string.
+ /// In a IDictionary, an empty string is a valid value,
+ /// so the entry for the control will still exist.
+ /// </p></remarks>
///
bool NullIfEmpty { get; set; }
/// <summary>
- /// String token to insert as item 0 to a list controls ["--v---"].
+ /// Provide a string token to insert as item 0 to a list controls ["--v--"].
/// </summary>
/// <remarks><p>
/// To disable feature, set to a null string.
@@ -238,7 +242,7 @@
// ----
/// <summary>
- /// The catalog for this helper,
+ /// Provide the catalog for this helper,
/// usually set by dependency injection.
/// </summary>
///
@@ -246,8 +250,8 @@
/// <summary>
- /// The command (or chain of commands) for this helper, usually set
- /// by dependency injection.
+ /// Provide the command (or chain of commands) for this helper,
+ /// usually set by dependency injection.
/// </summary>
///
IRequestCommand Command { get; set; }
Modified: struts/sandbox/trunk/overdrive/Nexus/Core/IRequestChain.cs
URL: http://svn.apache.org/viewcvs/struts/sandbox/trunk/overdrive/Nexus/Core/IRequestChain.cs?rev=190791&r1=190790&r2=190791&view=diff
==============================================================================
--- struts/sandbox/trunk/overdrive/Nexus/Core/IRequestChain.cs (original)
+++ struts/sandbox/trunk/overdrive/Nexus/Core/IRequestChain.cs Wed Jun 15 12:03:43 2005
@@ -3,7 +3,7 @@
namespace Nexus.Core
{
/// <summary>
- /// Composite IChain with IRequestCommand.
+ /// Composite IChain and IRequestCommand.
/// </summary>
public interface IRequestChain: IChain, IRequestCommand
{
Modified: struts/sandbox/trunk/overdrive/Nexus/Core/IRequestCommand.cs
URL: http://svn.apache.org/viewcvs/struts/sandbox/trunk/overdrive/Nexus/Core/IRequestCommand.cs?rev=190791&r1=190790&r2=190791&view=diff
==============================================================================
--- struts/sandbox/trunk/overdrive/Nexus/Core/IRequestCommand.cs (original)
+++ struts/sandbox/trunk/overdrive/Nexus/Core/IRequestCommand.cs Wed Jun 15 12:03:43 2005
@@ -82,7 +82,7 @@
IList AddRequiredIDs { set; }
/// <summary>
- /// Field IDs related to this Command, including any RequiredIDs.
+ /// Record FieldContext IDs related to this Command, including any RequiredIDs.
/// </summary>
/// <remarks><p>
/// If a Field ID is not specified as a RelatedID or a RequiredID,
@@ -115,7 +115,7 @@
IList AddRelatedIDs { set; }
/// <summary>
- /// Field IDs provided during the processing of a Chain.
+ /// Record Field IDs provided during the processing of a Chain.
/// </summary>
/// <remarks><p>
/// When Commands are chained, the output from one Command may be used
@@ -136,7 +136,7 @@
IList AddRuntimeIDs { set; }
/// <summary>
- /// Operations to perform with HelperContext.
+ /// Invoke the business operation.
/// </summary>
/// <remarks><p>
/// Expected to be called from Execute as a casting convenience.
Modified: struts/sandbox/trunk/overdrive/Nexus/Core/IRequestContext.cs
URL: http://svn.apache.org/viewcvs/struts/sandbox/trunk/overdrive/Nexus/Core/IRequestContext.cs?rev=190791&r1=190790&r2=190791&view=diff
==============================================================================
--- struts/sandbox/trunk/overdrive/Nexus/Core/IRequestContext.cs (original)
+++ struts/sandbox/trunk/overdrive/Nexus/Core/IRequestContext.cs Wed Jun 15 12:03:43 2005
@@ -64,7 +64,7 @@
/// <summary>
- /// Provide the Field Table for this Context.
+ /// Provide the FieldTable for this Context.
/// </summary>
/// <remarks><p>
/// The default implementation uses the Catalog to inject the global
@@ -94,7 +94,8 @@
/// list under their own Command ID.
/// Outcome is a convenience method to access the
/// initial or "outermost" Command or Chain ID.
- /// </p><p>
+ /// </p>
+ /// <p>
/// To allow use as subcommands in a Chain,
/// IRequestCommand implementations should prefer the idiom
/// <code>Context[ID] = object</code>
Modified: struts/sandbox/trunk/overdrive/Nexus/Core/Tables/IFieldTable.cs
URL: http://svn.apache.org/viewcvs/struts/sandbox/trunk/overdrive/Nexus/Core/Tables/IFieldTable.cs?rev=190791&r1=190790&r2=190791&view=diff
==============================================================================
--- struts/sandbox/trunk/overdrive/Nexus/Core/Tables/IFieldTable.cs (original)
+++ struts/sandbox/trunk/overdrive/Nexus/Core/Tables/IFieldTable.cs Wed Jun 15 12:03:43 2005
@@ -24,14 +24,14 @@
IList AddFields { set; }
/// <summary>
- /// If true, requires that all fields, including strings fields,
- /// be specified [FALSE].
+ /// Indicate whether this FieldTable must include all fields,
+ /// including strings fields [FALSE].
/// </summary>
///
bool Strict { set; get; }
/// <summary>
- /// For a given field id, return the Alert message.
+ /// Provide the Alert message for a given field id.
/// </summary>
/// <param name="id">FieldContext ID</param>
/// <returns>Alert mesasge for FieldContext ID</returns>
@@ -39,8 +39,8 @@
string Alert (string id);
/// <summary>
- /// Utilitizing the FieldContext settings, convert and copy values
- /// from the Criteria into the main Context.
+ /// Convert and copy values from the Criteria into the main Context,
+ /// utilitizing the FieldContext settings.
/// </summary>
/// <param name="context">Context to process (including Criteria)</param>
/// <returns>True if nominal</returns>
@@ -48,8 +48,8 @@
bool Convert (IValidatorContext context);
/// <summary>
- /// Utilizing the FieldContext settings, format and copy values from
- /// the main Context into the Criteria.
+ /// Format and copy values from the main Context into the Criteria,
+ /// utilizing the FieldContext settings.
/// </summary>
/// <param name="context">Context to process (including Criteria)</param>
/// <returns>True if nominal</returns>
@@ -67,7 +67,7 @@
bool IsRichControl (string name);
/// <summary>
- /// Obtains the FieldContext for the given ID.
+ /// Obtain the FieldContext for the given ID.
/// </summary>
/// <param name="id">FieldContext ID</param>
/// <returns>FieldContext for ID</returns>
Modified: struts/sandbox/trunk/overdrive/Nexus/Core/Tokens.cs
URL: http://svn.apache.org/viewcvs/struts/sandbox/trunk/overdrive/Nexus/Core/Tokens.cs?rev=190791&r1=190790&r2=190791&view=diff
==============================================================================
--- struts/sandbox/trunk/overdrive/Nexus/Core/Tokens.cs (original)
+++ struts/sandbox/trunk/overdrive/Nexus/Core/Tokens.cs Wed Jun 15 12:03:43 2005
@@ -17,7 +17,7 @@
namespace Nexus.Core
{
/// <summary>
- /// Tokens representing context keys.
+ /// Provide tokens representing context keys.
/// </summary>
/// <remarks><p>
/// The common convention of using CAPITALS for constants
@@ -113,6 +113,12 @@
public const string Fault = "_Fault";
/// <summary>
+ /// Token for FieldKey property.
+ /// </summary>
+ ///
+ public const string FieldKey = "_FieldKey";
+
+ /// <summary>
/// Token for FieldSet property.
/// </summary>
///
@@ -186,6 +192,19 @@
/// </summary>
///
public const string SelectItemPrompt = "_SelectItemPrompt";
+
+ /// <summary>
+ /// Token for Source property.
+ /// </summary>
+ ///
+ public const string Source = "_Source";
+
+ /// <summary>
+ /// Token for Target property.
+ /// </summary>
+ ///
+ public const string Target = "_Target";
+
#endregion
Modified: struts/sandbox/trunk/overdrive/Nexus/Core/Validators/IValidator.cs
URL: http://svn.apache.org/viewcvs/struts/sandbox/trunk/overdrive/Nexus/Core/Validators/IValidator.cs?rev=190791&r1=190790&r2=190791&view=diff
==============================================================================
--- struts/sandbox/trunk/overdrive/Nexus/Core/Validators/IValidator.cs (original)
+++ struts/sandbox/trunk/overdrive/Nexus/Core/Validators/IValidator.cs Wed Jun 15 12:03:43 2005
@@ -3,8 +3,7 @@
namespace Nexus.Core.Validators
{
/// <summary>
- /// A IValidator command is a NexusCommand that provides a message Template to use
- /// when validation fails.
+ /// Provide a message Template to use when validation fails [OVR-13].
/// </summary>
public interface IValidatorCommand : IRequestCommand
{
Modified: struts/sandbox/trunk/overdrive/Nexus/Core/Validators/Validator.cs
URL: http://svn.apache.org/viewcvs/struts/sandbox/trunk/overdrive/Nexus/Core/Validators/Validator.cs?rev=190791&r1=190790&r2=190791&view=diff
==============================================================================
--- struts/sandbox/trunk/overdrive/Nexus/Core/Validators/Validator.cs (original)
+++ struts/sandbox/trunk/overdrive/Nexus/Core/Validators/Validator.cs Wed Jun 15 12:03:43 2005
@@ -6,7 +6,7 @@
namespace Nexus.Core.Validators
{
/// <summary>
- /// A base class to use when implementating Validators.
+ /// Provide a base class to use when implementating Validators.
/// </summary>
/// <remarks>
/// Subclasses must provide a NexusExecute method.
Modified: struts/sandbox/trunk/overdrive/Nexus/Core/Validators/ValidatorContext.cs
URL: http://svn.apache.org/viewcvs/struts/sandbox/trunk/overdrive/Nexus/Core/Validators/ValidatorContext.cs?rev=190791&r1=190790&r2=190791&view=diff
==============================================================================
--- struts/sandbox/trunk/overdrive/Nexus/Core/Validators/ValidatorContext.cs (original)
+++ struts/sandbox/trunk/overdrive/Nexus/Core/Validators/ValidatorContext.cs Wed Jun 15 12:03:43 2005
@@ -1,10 +1,11 @@
using Agility.Core;
+using Nexus.Core;
using Nexus.Core.Validators;
namespace Agility.Nexus.Validators
{
/// <summary>
- /// Concrete IValidatorContext implementation.
+ /// Implement IValidatorContext.
/// </summary>
public class ValidatorContext : Context, IValidatorContext
{
@@ -18,25 +19,22 @@
Source = source;
}
- private const string _FieldKey = "_FieldKey";
public string FieldKey
{
- get { return this [_FieldKey] as string; }
- set { this [_FieldKey] = value; }
+ get { return this [Tokens.FieldKey] as string; }
+ set { this [Tokens.FieldKey] = value; }
}
- private const string _Source = "_Source";
public object Source
{
- get { return this [_Source]; }
- set { this [_Source] = value; }
+ get { return this [Tokens.Source]; }
+ set { this [Tokens.Source] = value; }
}
- private const string _Target = "_Target";
public object Target
{
- get { return this [_Target]; }
- set { this [_Target] = value; }
+ get { return this [Tokens.Target]; }
+ set { this [Tokens.Target] = value; }
}
}
}
Modified: struts/sandbox/trunk/overdrive/Nexus/Test/Test.csproj
URL: http://svn.apache.org/viewcvs/struts/sandbox/trunk/overdrive/Nexus/Test/Test.csproj?rev=190791&r1=190790&r2=190791&view=diff
==============================================================================
--- struts/sandbox/trunk/overdrive/Nexus/Test/Test.csproj (original)
+++ struts/sandbox/trunk/overdrive/Nexus/Test/Test.csproj Wed Jun 15 12:03:43 2005
@@ -29,7 +29,7 @@
CheckForOverflowUnderflow = "false"
ConfigurationOverrideFile = ""
DefineConstants = "DEBUG;TRACE"
- DocumentationFile = ""
+ DocumentationFile = "Nexus.Test"
DebugSymbols = "true"
FileAlignment = "4096"
IncrementalBuild = "false"
Modified: struts/sandbox/trunk/overdrive/Nexus/Web/Web.csproj
URL: http://svn.apache.org/viewcvs/struts/sandbox/trunk/overdrive/Nexus/Web/Web.csproj?rev=190791&r1=190790&r2=190791&view=diff
==============================================================================
--- struts/sandbox/trunk/overdrive/Nexus/Web/Web.csproj (original)
+++ struts/sandbox/trunk/overdrive/Nexus/Web/Web.csproj Wed Jun 15 12:03:43 2005
@@ -29,7 +29,7 @@
CheckForOverflowUnderflow = "false"
ConfigurationOverrideFile = ""
DefineConstants = "DEBUG;TRACE"
- DocumentationFile = ""
+ DocumentationFile = "Nexus.Web"
DebugSymbols = "true"
FileAlignment = "4096"
IncrementalBuild = "false"
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org