You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@beehive.apache.org by "Jeremiah Johnson (JIRA)" <de...@beehive.apache.org> on 2005/09/12 21:24:30 UTC
[jira] Created: (BEEHIVE-922) group of doc issues in Controls Programming document
group of doc issues in Controls Programming document
----------------------------------------------------
Key: BEEHIVE-922
URL: http://issues.apache.org/jira/browse/BEEHIVE-922
Project: Beehive
Type: Bug
Components: Documentation
Versions: V1
Environment: dist built from SVN r280352
Reporter: Jeremiah Johnson
Assigned to: Jeremiah Johnson
Priority: Minor
Fix For: V1
There are a few errors in trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml
If this issue is assigned to me, please don't fix the document yet - I haven't finished going through it. I decided to create this bug so I could add issues from the document as they came up. I had created BEEHIVE-917 with a specific scope, but I see now that there are a few unrelated issues in the document so I'm creating this new bug to track everything I find (that is outside the scope of BEEHIVE-917).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
controls programming doc issues [was: [Fwd: [jira] Commented: (BEEHIVE-922) group of doc issues in Controls Programming document]]
Posted by Eddie O'Neil <ek...@gmail.com>.
Steve--
Since you've done a fair bit of work here in the past, is there any
chance that you're looking at these? Jeremiah, can you submit patches
for these problems?
Eddie
---------- Forwarded message ----------
From: Jeremiah Johnson (JIRA) <de...@beehive.apache.org>
Date: Sep 12, 2005 4:51 PM
Subject: [jira] Commented: (BEEHIVE-922) group of doc issues in
Controls Programming document
To: dev@beehive.apache.org
[ http://issues.apache.org/jira/browse/BEEHIVE-922?page=comments#action_12323288
]
Jeremiah Johnson commented on BEEHIVE-922:
------------------------------------------
Section 11.1 has more munged example source:
--- should be
package org.apache.beehive.controls.examples;
import org.apache.beehive.controls.api.bean.ControlExtension;
import org.apache.beehive.controls.examples.JmsMessageControl.*;
@ControlExtension
@Destination( type=DestinationType.QUEUE, name="queue.orders" )
public interface OrderQueue extends JmsMessageControl
{
...
}
---
Then the example below that needs some corrections and then some.
Notice the [] in the ctor params and addition of MessageType.
--- should be
public class Order implements java.io.Serializable {
public Order( int buyer, String[] list ) {
buyerID = buyer;
itemList = list;
}
private int buyerID;
private String[] itemList;
}
@Message( MessageType.OBJECT )
public void submitOrder(
@Body Order order,
@Property(name="DeliverBy") String deliverBy
);
---
The example in Section 11.2 needs the enums qualified
(RetentionPolicy.RUNTIME, ElementType.METHOD and param, and
MessageType.TEXT in Message), remove the javax.jms.Message import, add
the additional imports for RetentionPolicy and ElementType, and an '@'
in the Body interface.
Section 11.3 needs java.lang.reflect.Method imported.
> group of doc issues in Controls Programming document
> ----------------------------------------------------
>
> Key: BEEHIVE-922
> URL: http://issues.apache.org/jira/browse/BEEHIVE-922
> Project: Beehive
> Type: Bug
> Components: Documentation
> Versions: V1
> Environment: dist built from SVN r280352
> Reporter: Jeremiah Johnson
> Assignee: Jeremiah Johnson
> Priority: Minor
> Fix For: V1
>
> There are a few errors in trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml
> If this issue is assigned to me, please don't fix the document yet - I haven't finished going through it. I decided to create this bug so I could add issues from the document as they came up. I had created BEEHIVE-917 with a specific scope, but I see now that there are a few unrelated issues in the document so I'm creating this new bug to track everything I find (that is outside the scope of BEEHIVE-917).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
Re: [jira] Assigned: (BEEHIVE-922) group of doc issues in Controls Programming document
Posted by Eddie O'Neil <ek...@gmail.com>.
Jeremiah--
Do you have a patch for this? If so, I can just apply it. Didn't
see one in the bug, so figured I'd ask.
:)
Eddie
On 9/19/05, Jeremiah Johnson (JIRA) <de...@beehive.apache.org> wrote:
> [ http://issues.apache.org/jira/browse/BEEHIVE-922?page=all ]
>
> Jeremiah Johnson reassigned BEEHIVE-922:
> ----------------------------------------
>
> Assign To: Steve Hanson (was: Jeremiah Johnson)
>
> All of the issues that I have raised here have now been fixed except for one. Assigning to Steve to fix and then we can resolve / close this. Thanks for all the fixes already, Steve.
>
> Section 10.5 has an inaccurate paragraph. It may be a bug in the Control implementation or it may have just been a change in requirements - I don't know that. For now, the paragraph needs to go away.
>
> --- the lines that I propose being removed
> - <p>
> - When constraining properties with <code>@AnnotationConstraints</code>, all of the property members must be annotated
> - with <code>@AnnotationMemberTypes</code>, or compile errors will be thrown. For example, the following
> - will <em>not</em> compile, because not all of the propertymembers (namely <code>someMember3()</code>)
> - are decorated with <code>@AnnotationMemberTypes</code>.
> - </p>
> -<source>
> - @AnnotationConstraints.MembershipRule(AnnotationConstraints.MembershipRuleValues.EXACTLY_ONE)
> - public @interface SomeProperty
> - {
> - @AnnotationMemberTypes.Text(maxLength=8)
> - public String someMember();
> - @AnnotationMemberTypes.Text(maxLength=8)
> - public String someMember2();
> - <strong>public String someMember3();</strong>
> - }</source>
> ---
>
>
>
> > group of doc issues in Controls Programming document
> > ----------------------------------------------------
> >
> > Key: BEEHIVE-922
> > URL: http://issues.apache.org/jira/browse/BEEHIVE-922
> > Project: Beehive
> > Type: Bug
> > Components: Documentation
> > Versions: V1
> > Environment: dist built from SVN r280352
> > Reporter: Jeremiah Johnson
> > Assignee: Steve Hanson
> > Priority: Minor
> > Fix For: V1
>
> >
> > There are a few errors in trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml
> > If this issue is assigned to me, please don't fix the document yet - I haven't finished going through it. I decided to create this bug so I could add issues from the document as they came up. I had created BEEHIVE-917 with a specific scope, but I see now that there are a few unrelated issues in the document so I'm creating this new bug to track everything I find (that is outside the scope of BEEHIVE-917).
>
> --
> This message is automatically generated by JIRA.
> -
> If you think it was sent incorrectly contact one of the administrators:
> http://issues.apache.org/jira/secure/Administrators.jspa
> -
> For more information on JIRA, see:
> http://www.atlassian.com/software/jira
>
>
[jira] Updated: (BEEHIVE-922) group of doc issues in Controls Programming document
Posted by "Jeremiah Johnson (JIRA)" <de...@beehive.apache.org>.
[ http://issues.apache.org/jira/browse/BEEHIVE-922?page=all ]
Jeremiah Johnson updated BEEHIVE-922:
-------------------------------------
Attachment: BEEHIVE-922-patch.txt
BEEHIVE-922-patch.txt is a patch for the paragraph that I believe needs to be removed.
> group of doc issues in Controls Programming document
> ----------------------------------------------------
>
> Key: BEEHIVE-922
> URL: http://issues.apache.org/jira/browse/BEEHIVE-922
> Project: Beehive
> Type: Bug
> Components: Documentation
> Versions: V1
> Environment: dist built from SVN r280352
> Reporter: Jeremiah Johnson
> Assignee: Steve Hanson
> Priority: Minor
> Fix For: V1
> Attachments: BEEHIVE-922-patch.txt
>
> There are a few errors in trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml
> If this issue is assigned to me, please don't fix the document yet - I haven't finished going through it. I decided to create this bug so I could add issues from the document as they came up. I had created BEEHIVE-917 with a specific scope, but I see now that there are a few unrelated issues in the document so I'm creating this new bug to track everything I find (that is outside the scope of BEEHIVE-917).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
[jira] Commented: (BEEHIVE-922) group of doc issues in Controls Programming document
Posted by "Jeremiah Johnson (JIRA)" <de...@beehive.apache.org>.
[ http://issues.apache.org/jira/browse/BEEHIVE-922?page=comments#action_12323280 ]
Jeremiah Johnson commented on BEEHIVE-922:
------------------------------------------
Most of the properties examples have issues. I believe that many people will look at the examples and play with them before reading the full document, so I think that these issues should be fixed.
Properties example is Section 10.1 should be changed so it will compile.
--- current example
@PropertySet( prefix="Destination" )
@Target( { FIELD, TYPE } )
@Retention( RetentionPolicy.RUNTIME )
public @interface Destination {
public DestinationType type() default DestinationType.QUEUE;
public String name();
}
--- should be changed to
@PropertySet( prefix="Destination" )
@Target( { ElementType.FIELD, ElementType.TYPE } )
@Retention( RetentionPolicy.RUNTIME )
public @interface Destination {
public DestinationType type() default DestinationType.QUEUE;
public String name();
}
---
Related to the definition of the properties, the clip in Section 10.2 that uses the properties is wrong.
--- current example
jmsBean.setDestinationType( Destination.QUEUE );
--- should be changed to
jmsBean.setDestinationType( DestinationType.QUEUE );
---
I think that leaving that example as it would misrepresent the relationship of the enum and property, so I definitely think that it should be changed.
Section 10.3 uses some life-cycle events to demonstrate getting a property value. Life-cycle events aren't introduce until Section 14 and the example, as it is, won't compile because of import issues. I think that more clear example, at this point, would be to put the property query into the method already defined in the JmsMessageControlImpl. Possibly take the clip from Section 9.2 and replace the ServletContext stuff with this:
---
Destination destinationProperty = (Destination) context.getControlPropertySet( Hello.Destination.class );
if( destinationProperty == null ) {
System.out.println( "Dest Property NOT Set" );
} else {
System.out.println( "Dest Property Set" );
}
---
Add a line-break to the examples in Section 10.5 in the lines using @AnnotationConstraints because the PDF (in AcroRead on Windows) is unreadable on those lines. Also, show the imports in those examples like the other examples in the document so that people learning from the examples will be able to code stuff up quickly.
--- current text
@AnnotationConstraints.MembershipRule(AnnotationConstraints.MembershipRuleValues.EXACTLY_ONE)
--- should change to
@AnnotationConstraints.MembershipRule(
AnnotationConstraints.MembershipRuleValues.EXACTLY_ONE)
---
I'd like to see the client code in Section 10.5 change so it will clearly demonstrate the violation of the appropriate rule. As it is, the max length rule of title, the max length rule of subject, and the exactly one rule are all violated, but the text only talks about the exactly one rule.
--- current example
@BookControl.Intro( title="some title", subject="some subject" )
--- should change to
@BookControl.Intro( title="title", subject="subject" )
---
> group of doc issues in Controls Programming document
> ----------------------------------------------------
>
> Key: BEEHIVE-922
> URL: http://issues.apache.org/jira/browse/BEEHIVE-922
> Project: Beehive
> Type: Bug
> Components: Documentation
> Versions: V1
> Environment: dist built from SVN r280352
> Reporter: Jeremiah Johnson
> Assignee: Jeremiah Johnson
> Priority: Minor
> Fix For: V1
>
> There are a few errors in trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml
> If this issue is assigned to me, please don't fix the document yet - I haven't finished going through it. I decided to create this bug so I could add issues from the document as they came up. I had created BEEHIVE-917 with a specific scope, but I see now that there are a few unrelated issues in the document so I'm creating this new bug to track everything I find (that is outside the scope of BEEHIVE-917).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
[jira] Assigned: (BEEHIVE-922) group of doc issues in Controls Programming document
Posted by "Jeremiah Johnson (JIRA)" <de...@beehive.apache.org>.
[ http://issues.apache.org/jira/browse/BEEHIVE-922?page=all ]
Jeremiah Johnson reassigned BEEHIVE-922:
----------------------------------------
Assign To: Steve Hanson (was: Jeremiah Johnson)
All of the issues that I have raised here have now been fixed except for one. Assigning to Steve to fix and then we can resolve / close this. Thanks for all the fixes already, Steve.
Section 10.5 has an inaccurate paragraph. It may be a bug in the Control implementation or it may have just been a change in requirements - I don't know that. For now, the paragraph needs to go away.
--- the lines that I propose being removed
- <p>
- When constraining properties with <code>@AnnotationConstraints</code>, all of the property members must be annotated
- with <code>@AnnotationMemberTypes</code>, or compile errors will be thrown. For example, the following
- will <em>not</em> compile, because not all of the propertymembers (namely <code>someMember3()</code>)
- are decorated with <code>@AnnotationMemberTypes</code>.
- </p>
-<source>
- @AnnotationConstraints.MembershipRule(AnnotationConstraints.MembershipRuleValues.EXACTLY_ONE)
- public @interface SomeProperty
- {
- @AnnotationMemberTypes.Text(maxLength=8)
- public String someMember();
- @AnnotationMemberTypes.Text(maxLength=8)
- public String someMember2();
- <strong>public String someMember3();</strong>
- }</source>
---
> group of doc issues in Controls Programming document
> ----------------------------------------------------
>
> Key: BEEHIVE-922
> URL: http://issues.apache.org/jira/browse/BEEHIVE-922
> Project: Beehive
> Type: Bug
> Components: Documentation
> Versions: V1
> Environment: dist built from SVN r280352
> Reporter: Jeremiah Johnson
> Assignee: Steve Hanson
> Priority: Minor
> Fix For: V1
>
> There are a few errors in trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml
> If this issue is assigned to me, please don't fix the document yet - I haven't finished going through it. I decided to create this bug so I could add issues from the document as they came up. I had created BEEHIVE-917 with a specific scope, but I see now that there are a few unrelated issues in the document so I'm creating this new bug to track everything I find (that is outside the scope of BEEHIVE-917).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
[jira] Assigned: (BEEHIVE-922) group of doc issues in Controls Programming document
Posted by "Jeremiah Johnson (JIRA)" <de...@beehive.apache.org>.
[ http://issues.apache.org/jira/browse/BEEHIVE-922?page=all ]
Jeremiah Johnson reassigned BEEHIVE-922:
----------------------------------------
Assign To: Eddie O'Neil (was: Steve Hanson)
Eddie is willing to apply, so assigning to Eddie.
> group of doc issues in Controls Programming document
> ----------------------------------------------------
>
> Key: BEEHIVE-922
> URL: http://issues.apache.org/jira/browse/BEEHIVE-922
> Project: Beehive
> Type: Bug
> Components: Documentation
> Versions: V1
> Environment: dist built from SVN r280352
> Reporter: Jeremiah Johnson
> Assignee: Eddie O'Neil
> Priority: Minor
> Fix For: V1
> Attachments: BEEHIVE-922-patch.txt
>
> There are a few errors in trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml
> If this issue is assigned to me, please don't fix the document yet - I haven't finished going through it. I decided to create this bug so I could add issues from the document as they came up. I had created BEEHIVE-917 with a specific scope, but I see now that there are a few unrelated issues in the document so I'm creating this new bug to track everything I find (that is outside the scope of BEEHIVE-917).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
[jira] Closed: (BEEHIVE-922) group of doc issues in Controls Programming document
Posted by "Jeremiah Johnson (JIRA)" <de...@beehive.apache.org>.
[ http://issues.apache.org/jira/browse/BEEHIVE-922?page=all ]
Jeremiah Johnson closed BEEHIVE-922:
------------------------------------
Assign To: Jeremiah Johnson (was: Eddie O'Neil)
Verified in RC4 and dist built from trunk on SVN 292543.
> group of doc issues in Controls Programming document
> ----------------------------------------------------
>
> Key: BEEHIVE-922
> URL: http://issues.apache.org/jira/browse/BEEHIVE-922
> Project: Beehive
> Type: Bug
> Components: Documentation
> Versions: V1
> Environment: dist built from SVN r280352
> Reporter: Jeremiah Johnson
> Assignee: Jeremiah Johnson
> Priority: Minor
> Fix For: V1
> Attachments: BEEHIVE-922-patch.txt
>
> There are a few errors in trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml
> If this issue is assigned to me, please don't fix the document yet - I haven't finished going through it. I decided to create this bug so I could add issues from the document as they came up. I had created BEEHIVE-917 with a specific scope, but I see now that there are a few unrelated issues in the document so I'm creating this new bug to track everything I find (that is outside the scope of BEEHIVE-917).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
[jira] Resolved: (BEEHIVE-922) group of doc issues in Controls Programming document
Posted by "Eddie O'Neil (JIRA)" <de...@beehive.apache.org>.
[ http://issues.apache.org/jira/browse/BEEHIVE-922?page=all ]
Eddie O'Neil resolved BEEHIVE-922:
----------------------------------
Resolution: Fixed
Fixed in SVN 290287. Thanks, Jeremiah.
> group of doc issues in Controls Programming document
> ----------------------------------------------------
>
> Key: BEEHIVE-922
> URL: http://issues.apache.org/jira/browse/BEEHIVE-922
> Project: Beehive
> Type: Bug
> Components: Documentation
> Versions: V1
> Environment: dist built from SVN r280352
> Reporter: Jeremiah Johnson
> Assignee: Eddie O'Neil
> Priority: Minor
> Fix For: V1
> Attachments: BEEHIVE-922-patch.txt
>
> There are a few errors in trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml
> If this issue is assigned to me, please don't fix the document yet - I haven't finished going through it. I decided to create this bug so I could add issues from the document as they came up. I had created BEEHIVE-917 with a specific scope, but I see now that there are a few unrelated issues in the document so I'm creating this new bug to track everything I find (that is outside the scope of BEEHIVE-917).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
[jira] Commented: (BEEHIVE-922) group of doc issues in Controls Programming document
Posted by "Jeremiah Johnson (JIRA)" <de...@beehive.apache.org>.
[ http://issues.apache.org/jira/browse/BEEHIVE-922?page=comments#action_12323288 ]
Jeremiah Johnson commented on BEEHIVE-922:
------------------------------------------
Section 11.1 has more munged example source:
--- should be
package org.apache.beehive.controls.examples;
import org.apache.beehive.controls.api.bean.ControlExtension;
import org.apache.beehive.controls.examples.JmsMessageControl.*;
@ControlExtension
@Destination( type=DestinationType.QUEUE, name="queue.orders" )
public interface OrderQueue extends JmsMessageControl
{
...
}
---
Then the example below that needs some corrections and then some. Notice the [] in the ctor params and addition of MessageType.
--- should be
public class Order implements java.io.Serializable {
public Order( int buyer, String[] list ) {
buyerID = buyer;
itemList = list;
}
private int buyerID;
private String[] itemList;
}
@Message( MessageType.OBJECT )
public void submitOrder(
@Body Order order,
@Property(name="DeliverBy") String deliverBy
);
---
The example in Section 11.2 needs the enums qualified (RetentionPolicy.RUNTIME, ElementType.METHOD and param, and MessageType.TEXT in Message), remove the javax.jms.Message import, add the additional imports for RetentionPolicy and ElementType, and an '@' in the Body interface.
Section 11.3 needs java.lang.reflect.Method imported.
> group of doc issues in Controls Programming document
> ----------------------------------------------------
>
> Key: BEEHIVE-922
> URL: http://issues.apache.org/jira/browse/BEEHIVE-922
> Project: Beehive
> Type: Bug
> Components: Documentation
> Versions: V1
> Environment: dist built from SVN r280352
> Reporter: Jeremiah Johnson
> Assignee: Jeremiah Johnson
> Priority: Minor
> Fix For: V1
>
> There are a few errors in trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml
> If this issue is assigned to me, please don't fix the document yet - I haven't finished going through it. I decided to create this bug so I could add issues from the document as they came up. I had created BEEHIVE-917 with a specific scope, but I see now that there are a few unrelated issues in the document so I'm creating this new bug to track everything I find (that is outside the scope of BEEHIVE-917).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
[jira] Commented: (BEEHIVE-922) group of doc issues in Controls Programming document
Posted by "Jeremiah Johnson (JIRA)" <de...@beehive.apache.org>.
[ http://issues.apache.org/jira/browse/BEEHIVE-922?page=comments#action_12323271 ]
Jeremiah Johnson commented on BEEHIVE-922:
------------------------------------------
All examples of PublisherControl are broken: they imply that a ControlInterface may be abstract, but that isn't the case.
--- current example
public class PublisherControlImpl extends PublisherControl
--- the simplest fix for that would be
public class PublisherControlImpl implements PublisherControl
---
This appears in sections 6.1 (in two separate examples) and in section 8.3.1. The Control Interface may not be a class or abstract class; if a developer attempts to write a Control Interface as anything but an interface, they will get this message from APT: "The ControlInterface or ControlExtension annotation may only be used on a Java interface."
> group of doc issues in Controls Programming document
> ----------------------------------------------------
>
> Key: BEEHIVE-922
> URL: http://issues.apache.org/jira/browse/BEEHIVE-922
> Project: Beehive
> Type: Bug
> Components: Documentation
> Versions: V1
> Environment: dist built from SVN r280352
> Reporter: Jeremiah Johnson
> Assignee: Jeremiah Johnson
> Priority: Minor
> Fix For: V1
>
> There are a few errors in trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml
> If this issue is assigned to me, please don't fix the document yet - I haven't finished going through it. I decided to create this bug so I could add issues from the document as they came up. I had created BEEHIVE-917 with a specific scope, but I see now that there are a few unrelated issues in the document so I'm creating this new bug to track everything I find (that is outside the scope of BEEHIVE-917).
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira