org.jboss.dna.sequencer.java
Class JavaMetadataSequencer

java.lang.Object
  org.jboss.dna.sequencer.java.JavaMetadataSequencer

All Implemented Interfaces:

StreamSequencer, JavaSourceCndDefinition

public class JavaMetadataSequencer
extends Object
implements JavaSourceCndDefinition, StreamSequencer

A Java sequencer that processes a compilation unit, extracts the meta data for the compilation unit, and then writes these informations to the repository.

The structural representation of the informations from the compilation unit looks like this:

• java:compilationUnit node of type java:compilationUnit
  • java:package - optional child node that represents the package child node of the compilation unit.
    • java:packageDeclaration - the package declaration.
      • java:packageName
      - the package name.
  • java:import - optional child node that represents the import declaration of the compilation unit
    • java:importDeclaration - the import declaration
      • java:singleImport
        • java:singleTypeImportDeclaration
          • java:singleTypeImportkeyword - the keyword "import"
          • java:singleImportName
          - the name of a single import.
      • java:importOnDemand
      • java:typeImportOnDemandDeclaration
        • java:onDemandImportKeyword - the keyword "import"
        • java:onDemandImportName
        - the name of the on demand import.
  • java:unitType - optional child node that represents the top level type (class, interface, enum, annotation) declaration of the compilation unit
  • java:classDeclaration - optional child node that represents the class declaration of the compilation unit
    • java:normalClass - the normal class.
      • java:normalClassDeclaration - the normal class declaration
        • java:modifier - modifier child node.
          • java:modifierDeclaration - the modifier declaration.
            • java:modifierName - modifier name.
        • java:normalClassName - class name.
        • java:field - field child node.
          • java:fieldType - field type child node.
            • java:type - type child node.
              • [java:primitiveType, java:simpleType, java:parameterizedType] - can be primitive type or simple type and or parameterized type<.
        • java:constructor - the constructor child node
          • java:constructorDeclaration - the constructor declaration.
            • java:constructorName - constructor name.
            • java:modifier - the modifier child node.
            +
            • java:parameter - the parameter child node
        • java:method - method child node.
          • java:methodDeclaration - method declaration.
            • java:methodName - method name.
            • java:modifier - the modifier child node.
            +
            • java:resultType - the result type child node
            +
            • java:parameter - the parameter child node

  Author:

  Serge Pagop

  Field Summary

  Fields inherited from interface org.jboss.dna.sequencer.java.JavaSourceCndDefinition

  JAVA_ANNOTATION_CHILD_NODE, JAVA_ANNOTATION_DECLARATION_CHILD_NODE, JAVA_ANNOTATION_TYPE_CHILD_NODE, JAVA_ARRAY_TYPE_CHILD_NODE, JAVA_ARRAY_TYPE_DESCRIPTION, JAVA_ARRAY_TYPE_MODIFIER_CHILD_NODE, JAVA_ARRAY_TYPE_NAME, JAVA_ARRAY_TYPE_VARIABLE, JAVA_CLASS_DECLARATION_CHILD_NODE, JAVA_COMPILATION_UNIT_NODE, JAVA_COMPILATION_UNIT_PRIMARY_TYPE, JAVA_CONSTRUCTOR_CHILD_NODE, JAVA_CONSTRUCTOR_DECLARATION_CHILD_NODE, JAVA_CONSTRUCTOR_NAME, JAVA_FIELD_CHILD_NODE, JAVA_FIELD_TYPE_CHILD_NODE, JAVA_FORMAL_PARAMETER, JAVA_IMPORT_CHILD_NODE, JAVA_IMPORT_DECLARATION_CHILD_NODE, JAVA_MARKER_ANNOTATION_CHILD_NODE, JAVA_MARKER_ANNOTATION_NAME, JAVA_METHOD_CHILD_NODE, JAVA_METHOD_DECLARATION_CHILD_NODE, JAVA_METHOD_NAME, JAVA_MODIFIER_CHILD_NODE, JAVA_MODIFIER_DECLARATION_CHILD_NODE, JAVA_MODIFIER_NAME, JAVA_NORMAL_ANNOTATION_CHILD_NODE, JAVA_NORMAL_CLASS_CHILD_NODE, JAVA_NORMAL_CLASS_DECLARATION_CHILD_NODE, JAVA_NORMAL_CLASS_NAME, JAVA_NORMALANNOTATION_NAME, JAVA_ON_DEMAND_IMPORT_CHILD_NODE, JAVA_ON_DEMAND_IMPORT_NAME, JAVA_ON_DEMAND_IMPORT_TYPE_DECLARATION_CHILD_NODE, JAVA_PACKAGE_CHILD_NODE, JAVA_PACKAGE_DECLARATION_CHILD_NODE, JAVA_PACKAGE_NAME, JAVA_PARAMETER, JAVA_PARAMETER_NAME, JAVA_PARAMETERIZED_TYPE_CHILD_NODE, JAVA_PARAMETERIZED_TYPE_DESCRIPTION, JAVA_PARAMETERIZED_TYPE_MODIFIER_CHILD_NODE, JAVA_PARAMETERIZED_TYPE_NAME, JAVA_PARAMETERIZED_TYPE_VARIABLE, JAVA_PRIMITIVE_TYPE_CHILD_NODE, JAVA_PRIMITIVE_TYPE_NAME, JAVA_PRIMITIVE_TYPE_VARIABLE, JAVA_RETURN_TYPE, JAVA_SIMPLE_TYPE_CHILD_NODE, JAVA_SIMPLE_TYPE_DESCRIPTION, JAVA_SIMPLE_TYPE_MODIFIER_CHILD_NODE, JAVA_SIMPLE_TYPE_NAME, JAVA_SIMPLE_TYPE_VARIABLE, JAVA_SINGLE_ANNOTATION_NAME, JAVA_SINGLE_ELEMENT_ANNOTATION_CHILD_NODE, JAVA_SINGLE_IMPORT_CHILD_NODE, JAVA_SINGLE_IMPORT_NAME, JAVA_SINGLE_IMPORT_TYPE_DECLARATION_CHILD_NODE, JAVA_TYPE_CHILD_NODE, JAVA_UNIT_TYPE_CHILD_NODE, JAVA_VARIABLE, JAVA_VARIABLE_NAME, SLASH

  Constructor Summary

  JavaMetadataSequencer()
  

  Method Summary

  void	sequence(InputStream stream, SequencerOutput output, SequencerContext context, ProgressMonitor progressMonitor) Sequence the data found in the supplied stream, placing the output information into the supplied map.

  Methods inherited from class java.lang.Object

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

  Constructor Detail

  JavaMetadataSequencer

  public JavaMetadataSequencer()

  Method Detail

  sequence

  public void sequence(InputStream stream,
                       SequencerOutput output,
                       SequencerContext context,
                       ProgressMonitor progressMonitor)

  Sequence the data found in the supplied stream, placing the output information into the supplied map.

  JBoss DNA's SequencingService determines the sequencers that should be executed by monitoring the changes to one or more workspaces that it is monitoring. Changes in those workspaces are aggregated and used to determine which sequencers should be called. If the sequencer implements this interface, then this method is called with the property that is to be sequenced along with the interface used to register the output. The framework takes care of all the rest.

  This operation should report progress to the supplied ProgressMonitor. At the beginning of the operation, call ProgressMonitor.beginTask(double, org.jboss.dna.common.i18n.I18n, Object...) with a meaningful message describing the operation and a total for the amount of work that will be done by this sequencer. Then perform the sequencing work, periodically reporting work by specifying the amount of work that has was just completed or by creating a subtask and reporting work against that subtask monitor.

  The implementation should also periodically check whether the operation has been cancelled. If this method returns true, the implementation should abort all work as soon as possible and close any resources that were acquired or opened.

  Finally, the implementation should call ProgressMonitor.done() when the operation has finished.

  Specified by:

  sequence in interface StreamSequencer

  Parameters:

  stream - the stream with the data to be sequenced; never null

  output - the output from the sequencing operation; never null

  context - the context for the sequencing operation; never null

  progressMonitor - the progress monitor that should be kept updated with the sequencer's progress and that should be frequently consulted as to whether this operation has been cancelled.

  See Also:

  StreamSequencer.sequence(java.io.InputStream, org.jboss.dna.graph.sequencers.SequencerOutput, org.jboss.dna.graph.sequencers.SequencerContext, org.jboss.dna.common.monitor.ProgressMonitor)