org.apache.sling.maven.jcrocm
Class CollectionDescriptor

java.lang.Object
  org.apache.sling.maven.jcrocm.AbstractNodeDescriptor
      org.apache.sling.maven.jcrocm.CollectionDescriptor

public class CollectionDescriptor
extends AbstractNodeDescriptor

The CollectionDescriptor class provides support for the collection-descriptor element of a class mapping, which has the following attribute list definition:

  <!ATTLIST collection-descriptor
      fieldName CDATA #REQUIRED
      jcrName CDATA #IMPLIED 
      proxy (true | false) "false"
      autoRetrieve (true|false) "true"
      autoUpdate (true|false) "true"
      autoInsert (true|false) "true"  
      elementClassName CDATA #IMPLIED
      collectionClassName CDATA #IMPLIED
      collectionConverter CDATA #IMPLIED
      jcrType CDATA #IMPLIED
      jcrAutoCreated (true | false) "false"   
      jcrMandatory (true | false) "false"
      jcrOnParentVersion (COPY | VERSION | INITIALIZE | COMPUTE | IGNORE | ABORT) "COPY"
      jcrProtected (true | false) "false"
      jcrSameNameSiblings (true | false) "false"  
  >
 

Field Summary

static java.lang.String	ELEMENT_COLLECTION_DESCRIPTOR
static java.lang.String	FIELD_NAME The name of the Doclet Tag attribute naming the field to which the descriptor applies (value is "fieldName").
static java.lang.String	JCR_AUTO_CREATED The name of the Doclet Tag attribute naming the field to which the descriptor applies (value is "fieldName").
static java.lang.String	JCR_MANDATORY
static java.lang.String	JCR_NAME The name of the Doclet Tag attribute naming the JCR item to which the descriptor applies (value is "jcrName").
static java.lang.String	JCR_ON_PARENT_VERSION
static java.lang.String	JCR_PROTECTED
protected com.thoughtworks.qdox.model.DocletTag	tag
static java.lang.String	TAG_COLLECTION_DESCRIPTOR

Fields inherited from class org.apache.sling.maven.jcrocm.AbstractNodeDescriptor

AUTO_INSERT, AUTO_RETRIEVE, AUTO_UPDATE, JCR_SAME_NAME_SIBBLINGS, JCR_TYPE, PROXY

Constructor Summary

CollectionDescriptor(org.apache.maven.plugin.logging.Log log, com.thoughtworks.qdox.model.DocletTag tag, java.lang.String fieldName)

Method Summary

protected void	log(java.lang.String message)
protected void	warn(java.lang.String message)

Methods inherited from class java.lang.Object

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

Field Detail

TAG_COLLECTION_DESCRIPTOR

public static final java.lang.String TAG_COLLECTION_DESCRIPTOR

See Also:

Constant Field Values

ELEMENT_COLLECTION_DESCRIPTOR

public static final java.lang.String ELEMENT_COLLECTION_DESCRIPTOR

See Also:

Constant Field Values

FIELD_NAME

public static final java.lang.String FIELD_NAME

The name of the Doclet Tag attribute naming the field to which the descriptor applies (value is "fieldName").

See Also:

Constant Field Values

JCR_NAME

public static final java.lang.String JCR_NAME

The name of the Doclet Tag attribute naming the JCR item to which the descriptor applies (value is "jcrName").

See Also:

Constant Field Values

JCR_AUTO_CREATED

public static final java.lang.String JCR_AUTO_CREATED

The name of the Doclet Tag attribute naming the field to which the descriptor applies (value is "fieldName").

See Also:

Constant Field Values

JCR_MANDATORY

public static final java.lang.String JCR_MANDATORY

See Also:

Constant Field Values

JCR_ON_PARENT_VERSION

public static final java.lang.String JCR_ON_PARENT_VERSION

See Also:

Constant Field Values

JCR_PROTECTED

public static final java.lang.String JCR_PROTECTED

See Also:

Constant Field Values

tag

protected final com.thoughtworks.qdox.model.DocletTag tag

Constructor Detail

CollectionDescriptor

public CollectionDescriptor(org.apache.maven.plugin.logging.Log log,
                            com.thoughtworks.qdox.model.DocletTag tag,
                            java.lang.String fieldName)

Parameters:

log -

tag -

Method Detail

log

protected void log(java.lang.String message)

warn

protected void warn(java.lang.String message)