StructTagVerbforms

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sandev.generator.tags
Class StructTagVerbforms

java.lang.Object
  org.sandev.generator.tags.AbstractSandBaseTag
      org.sandev.generator.tags.AbstractSandClassTag
          org.sandev.generator.tags.AbstractSandStructTag
              org.sandev.generator.tags.StructTagVerbforms

All Implemented Interfaces:: com.sun.tools.doclets.Taglet

public class StructTagVerbforms
extends AbstractSandStructTag

Handle the @sand.verbforms declaration.

Declares zero or more SandVerbMessage forms which should be generated. You can specify zero or more of the following forms:

update
query
collection
history

Comments are not supported for this tag.

update:

Declares that an SandUpdateMessage verb form should be generated for this class. The update form is used for adding, updating, or deleting a message instance. Among other uses, it can be used to call the DataManager to affect the persistent state. Most persistent messages have an update verb form, with the rare exception of read-only data.

query:

Declares that a SandQueryMessage verb form should be generated for this message. The query form is used for retrieving a collection of message instances matching a given expression. Among other uses, it can be used to retrieve instances from the DataManager. Most persistent messages have a query form, with the rare exception of write-only data.

collection:

Declares that a SandCollectionMessage verb form should be generated for this message. The collection form is returned in response to a query. It can also be independently in non-update contexts with messages that carry their own action context.

history:

Declares that a SandHistoryMessage verb form should be generated for this message. This is only valid for persistent messages, and triggers the creation of two additional message types:

A history query verb message is generated. This is a SandQueryMessage that extends the normal query message but flags the query as being across versions in time. A history query must specify a single uniqueID.

A history collection verb message is generated. This is a SandCollectionMessage that extends the normal collection message but flags the collection as possibly containing multiple instances of the same message over time (same uniqueID, different revision numbers).

So a standard query, when given a date range for the lastModifiedTime, will return a collection with only the current instances matching that matched the specified timeframe. Each message in the collection will have different uniqueID. A historical query will return a collection with all the revisions of a single message instance in chronological order. All messages in the collection will have the same uniqueID, but different revisionNumbers.

Historical processing is not currently supported in the open source version of SandBoss. If your application requires historical processing contact Structs And Nodes Development Services for additional information.

Field Summary
`protected boolean`	`collection` Flag for collection
`static java.lang.String`	`CORENAME` The core name of this tag.
`protected boolean`	`history` Flag for history
`protected boolean`	`query` Flag for query
`static java.lang.String`	`TAGNAME` Our fixed name, used for hash lookup and text parsing.
`protected boolean`	`update` Flag for update

Fields inherited from class org.sandev.generator.tags.AbstractSandBaseTag

PREFIX

Constructor Summary
`StructTagVerbforms()`

Method Summary
`static boolean`	`exists(com.sun.javadoc.ClassDoc fd)` Returns true if the given field contains this tag, false otherwise.
`java.lang.String`	`getName()` Return our tag name
`static StructTagVerbforms`	`getStructTagVerbforms(com.sun.javadoc.ClassDoc cd)` Factory method for retrieving a new instance given a ClassDoc.
`boolean`	`hasCollection()` accessor for collection
`boolean`	`hasHistory()` accessor for history
`boolean`	`hasQuery()` accessor for query
`boolean`	`hasUpdate()` accessor for update
`void`	`init(com.sun.javadoc.Tag tag)` Initialize this instance from the tag information.
`boolean`	`isBaseOnly()` Returns true if there are no verb forms declared.
`static void`	`register(java.util.Map tagletMap)` Registers this taglet when triggered by the taglet declaration being loaded in as part of the build.
`void`	`setCollection(boolean val)` mutator for collection
`void`	`setHistory(boolean val)` mutator for history
`void`	`setQuery(boolean val)` mutator for query
`void`	`setUpdate(boolean val)` mutator for update
`java.lang.String`	`toString(com.sun.javadoc.Tag tag)` Return a documentation description of this tag.
`java.lang.String`	`toString(com.sun.javadoc.Tag[] tags)` Return the documentation text for when several of these tags are present

Methods inherited from class org.sandev.generator.tags.AbstractSandClassTag

inType

Methods inherited from class org.sandev.generator.tags.AbstractSandBaseTag

inConstructor, inField, inMethod, inOverview, inPackage, isInlineTag, registerHelper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CORENAME

public static final java.lang.String CORENAME

The core name of this tag.

See Also:: Constant Field Values

update

protected boolean update

Flag for update

query

protected boolean query

Flag for query

collection

protected boolean collection

Flag for collection

history

protected boolean history

Flag for history

TAGNAME

public static final java.lang.String TAGNAME

Our fixed name, used for hash lookup and text parsing.

See Also:: Constant Field Values

Constructor Detail