[Yanel-dev] Annotating resources

Thu Feb 24 09:24:12 CET 2011

Hi,
I am a bit irritated by the term "Annotations" and you should explain
somewhere what you mean by annotations. Otherwise Java developers probably
think about "the other" annotations which are around since JavaSE5.

Annotations are usually declarative configuration attributes on classes and
methods, like

@Singleton
public class DataService {
}

or

@XmlTransient
private String thisDoesNotGetPersisted = null;

Cheers
Balz

On Thu, Feb 24, 2011 at 9:18 AM, Schaaf Marc <marc.schaaf at fhnw.ch> wrote:

>  Hi
>
>
>
> Thanks Michael for applying my patches!
>
>
>
> As Michael already mentioned, they add basic support for annotations by
> introducing a new “Annotatable” interface which is currently implemented
> only by the XMLResource. Via this interface it is possible to
> set/get/remove/clear the annotations where an annotation is a simple string
> with no further properties (for now).  To allow the usage those annotations,
> they are also added to the access logging from where an analyzing component
> can read them together with the user requests.
>
>
>
> If you have any further questions, feel free to ask J
>
>
>
> Regards,
>
> Marc
>
>
>
> *Von:* yanel-development-bounces at wyona.com [mailto:
> yanel-development-bounces at wyona.com] *Im Auftrag von *Michael Wechner
> *Gesendet:* Mittwoch, 23. Februar 2011 13:08
> *An:* yanel-development at wyona.com
> *Betreff:* Re: [Yanel-dev] Annotating resources
>
>
>
> Hi
>
> Thanks to Marc the annotations are now also added to the access log:
>
> Sending        src/webapp/src/java/org/wyona/yanel/servlet/AccessLog.java
> Sending
> src/webapp/src/java/org/wyona/yanel/servlet/YanelServlet.java
> Transmitting file data ..
> Committed revision 56923.
>
> whereas the results of the review are:
>
>    - Does it build? YES (but it didn't originally because it broke
>    backwards compatibility)
>    - Is the formatting correct? Should be fixed now (used tabs instead of
>    spaces)
>    - Is there an automatic test? Make sure that there are automatic tests,
>    which are covering the changes which the patch will imply. NO
>    - Is it backwards compatible? YES (but it was broken, see
>    src/contributions/resources/contact-form/src/java/org/wyona/yanel/impl/resources/contactform/ContactResource.java)
>    - Does it scale/perform? (Can the implementation be changed?) YES and
>    NO, because the logging has become slower, but the analysis will become
>    faster and it is a workaround for the revision problem
>    - Can it be enhanced? Kind of ...
>    - Can it be customized? The annotation implementation can be customized
>    ....
>    - Does it work within a cluster? YES
>    - Is it secure? YES and NO, depends if the annotations contain "secret"
>    information
>    - Can it be used offline? YES
>    - Can the patch be reverted easily? YES
>    - Does it work for all browsers? Only tested Firefox yet
>
>
> Btw, I have also fixed that if a URL contains a query string that this is
> also written into the access log file,
> because for example in the case of introspection the "same" URL is called
> twice be the browser, e.g.
>
>
> http://127.0.0.1:8080/yanel/yanel-website/en/about.htm?yanel.resource.usecase=introspection
>
> Cheers
>
> Michael
>
>
>
> On 2/22/11 9:35 AM, Michael Wechner wrote:
>
> Hi
>
> Thanks to Marc Schaaf we now have an "Annotatable" interface which allows
> to annotate resources
> and also use this information for third party applications, e.g. Boost in
> order to generate tag clouds re what users are interested in. Marc has also
> created a simple annotation editor which is currently used by the yanel
> website realm.
>
> I guess Marc will send some more notes re further steps (e.g. re
> ontologies:
> http://en.wikipedia.org/wiki/Ontology_%28information_science%29)
>
> The basic code pieces are:
>
> U    conf/resource-types.xml
> A
> src/realms/yanel-website/res-configs-repo/data/usecases/pageMetadataManager.html.yanel-rc
> U
> src/realms/yanel-website/src/java/org/wyona/yanel/website/menu/impl/YanelWebsiteMenu.java
> U    src/realms/yanel-website/data-repo/data/xslt/global.xsl
> A    src/core/java/org/wyona/yanel/core/api/attributes/AnnotatableV1.java
> U
> src/resources/xml/src/java/org/wyona/yanel/impl/resources/XMLResource.java
> A    src/resources/pageMetaDataManager
> A
> src/resources/pageMetaDataManager/src/java/com/wyona/yanel/metadata/manager/PageMetaDataManager.java
>
> Re code review:
>
>    - Does it build? YES
>    - Is the formatting correct? Should be fixed now (used tabs instead of
>    spaces)
>    - Is there an automatic test? Make sure that there are automatic tests,
>    which are covering the changes which the patch will imply. NO
>    - Is it backwards compatible? YES, because annotations are implemented
>    as a versioned interface
>    - Does it scale/perform? (Can the implementation be changed?) YES,
>    because of doing it as an interface
>    - Can it be enhanced? YES, because of versioned interface
>    - Can it be customized? The implementation can be customized
>    - Does it work within a cluster? NOT really, because the properties are
>    not locked yet, but we will fix that shortly. But also depends on the
>    repository implementation.
>    - Is it secure? YES, if the policies for the editor are set correctly,
>    but NO otherwise
>    - Can it be used offline? YES
>    - Can the patch be reverted easily? NO, because various resource types
>    (e.g. XMLResource) will start implementing this interface
>    - Does it work for all browsers? Only tested Firefox yet
>
> Cheers
>
> Michael
>
>
>
> --
> Yanel-development mailing list Yanel-development at wyona.com
> http://lists.wyona.org/cgi-bin/mailman/listinfo/yanel-development
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.wyona.org/pipermail/yanel-development/attachments/20110224/42bcd9c4/attachment.html>