Introduced listener architecture, implemented updated model, final state

Author: Sebastian Höfer

…rib/plugin/javascript/JavaScriptLexer.g4 …gin/javascript/parser/JavaScriptLexer.g4src/main/antlr4/org/jqassistant/contrib/plugin/javascript/JavaScriptLexer.g4 renamed to src/main/antlr4/org/jqassistant/contrib/plugin/javascript/parser/JavaScriptLexer.g4 src/main/antlr4/org/jqassistant/contrib/plugin/javascript/JavaScriptLexer.g4 renamed to src/main/antlr4/org/jqassistant/contrib/plugin/javascript/parser/JavaScriptLexer.g4

@@ -4,18 +4,13 @@
 import com.buschmais.xo.neo4j.api.annotation.Label;
 
 /**
- * Interface used to describe the special type of a {@link BaseObjectDescriptor} called array.
- * 
+ * Interface that describes javascript arrays.
+ *
  * @author sh20xyqi
  */
+
 @Label(value = "Array", usingIndexedPropertyOf = FullQualifiedNameDescriptor.class)
-public interface ArrayDescriptor extends BaseObjectDescriptor {
+public interface ArrayDescriptor extends ComplexDescriptor {
 
-	public static final String ARRAY = "[array]";
-
-	@Override
-	default String getFullQualifiedName() {
-		return ARRAY;
-	}
 }
 

…ib/plugin/javascript/JavaScriptParser.g4 …in/javascript/parser/JavaScriptParser.g4src/main/antlr4/org/jqassistant/contrib/plugin/javascript/JavaScriptParser.g4 renamed to src/main/antlr4/org/jqassistant/contrib/plugin/javascript/parser/JavaScriptParser.g4 src/main/antlr4/org/jqassistant/contrib/plugin/javascript/JavaScriptParser.g4 renamed to src/main/antlr4/org/jqassistant/contrib/plugin/javascript/parser/JavaScriptParser.g4

@@ -3,10 +3,10 @@
 import com.buschmais.xo.neo4j.api.annotation.Label;
 
 /**
- * Interface for describing the primitive data type Boolean.
- * 
+ * Interface that describes javascript booleans.
+ *
  * @author sh20xyqi
  */
 
 @Label("Boolean")
-public interface BooleanDescriptor extends LiteralDescriptor<Boolean>{}
+public interface BooleanDescriptor extends PrimitiveDescriptor<Boolean>{}

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ArrayDescriptor.java

@@ -4,26 +4,18 @@
 import com.buschmais.xo.neo4j.api.annotation.Property;
 
 /**
- * Interface for describing a class.
+ * Interface for describing a javascript class.
  * 
  * @author sh20xyqi
  */
 @Label(value = "Class", usingIndexedPropertyOf = FullQualifiedNameDescriptor.class)
-public interface ClassDescriptor extends JsDescriptor, CodeArtifact, FullQualifiedNameDescriptor {
-    
-	/**
-     * Returns the name of the class.
-     * @return String 
-     */
-	@Property("NAME")
-    String getName();
-    void setName(String name);
+public interface ClassDescriptor extends CodeArtifact {
 
     /**
-     * Returns the super class of the class.
+     * Binds the parent class.
      * @return String
      */
-    @Property("EXTENDS")
+    @Property("extends")
     String getSuperClass();
     void setSuperClass(String superClass);
 

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/BaseObjectDescriptor.java

@@ -8,15 +8,16 @@
 import com.buschmais.xo.neo4j.api.annotation.Relation.Outgoing;
 
 /**
- * Interface to describe a JavaScript code artifact.
+ * Interface to describe a JavaScript code artifact: file, class, function or variable. Is not mentioned as a label in neo4j.
  * 
  * @author sh20xyqi
  */
 
-@Label("JavaScriptCode")
-public interface CodeArtifact extends FullQualifiedNameDescriptor, LineNumberDescriptor {
+@Label("")
+public interface CodeArtifact extends FullQualifiedNameDescriptor, LineNumberDescriptor, JavaScriptDescriptor {
 
 	public static final String DECLARES = "DECLARES";
+	public static final String HAS = "HAS";
 
 	@Outgoing
 	List<InvokesDescriptor> getInvokes();
@@ -35,13 +36,6 @@ public interface CodeArtifact extends FullQualifiedNameDescriptor, LineNumberDes
     @Relation(DECLARES)
     List<ClassDescriptor> getClasses();
 
-    /**
-     * Contains all named and anonymous {@link BaseObjectDescriptor} (e.g. {@link ObjectDescriptor} or {@link ArrayDescriptor}) that occur in this JavaScript code artifact.
-     * @return List of objects 
-     */
-    @Relation(DECLARES)
-    List<BaseObjectDescriptor> getObjects();
-    
     /**
      * Contains all named and anonymous {@link VariableDescriptor} that occur in this JavaScript code artifact.
      * @return List of variables
@@ -50,9 +44,10 @@ public interface CodeArtifact extends FullQualifiedNameDescriptor, LineNumberDes
     List<VariableDescriptor> getVariables();
 
     /**
-     * Contains all named and anonymous {@link LiteralDescriptor} (also called primitive data types) that occur in this JavaScript code artifact.
-     * @return List of literals (primitive data types)
+     * Contains all named and anonymous {@link ComplexDescriptor} (e.g. {@link ObjectDescriptor} or {@link ArrayDescriptor}) that occur in this JavaScript code artifact.
+     * @return List of objects 
      */
-    @Relation(DECLARES)
-    List<LiteralDescriptor<?>> getLiterals();
+    @Relation(HAS)
+    List<ComplexDescriptor> getObjects();
+    
 }

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/BooleanDescriptor.java

@@ -0,0 +1,14 @@
+package org.jqassistant.contrib.plugin.javascript.api.model;
+
+import com.buschmais.jqassistant.core.store.api.model.FullQualifiedNameDescriptor;
+import com.buschmais.xo.neo4j.api.annotation.Label;
+
+/**
+ * Interface for the description of data structures, which can be either an {@link ObjectDescriptor} or an {@kink ArrayDescriptor}.
+ * 
+ * @author sh20xyqi
+ */
+@Label(value = "", usingIndexedPropertyOf = FullQualifiedNameDescriptor.class)
+public interface ComplexDescriptor extends CodeArtifact, FullQualifiedNameDescriptor, ContainsPrimitiveDescriptor {
+
+}

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ClassDescriptor.java

@@ -0,0 +1,10 @@
+package org.jqassistant.contrib.plugin.javascript.api.model;
+
+import java.util.List;
+
+import com.buschmais.xo.neo4j.api.annotation.Relation;
+
+public interface ContainsPrimitiveDescriptor {
+    @Relation("HAS")
+    List<PrimitiveDescriptor<?>> getPrimitives();
+}

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/CodeArtifact.java

@@ -1,29 +1,19 @@
 package org.jqassistant.contrib.plugin.javascript.api.model;
 
+import java.util.List;
+
 import com.buschmais.jqassistant.core.store.api.model.FullQualifiedNameDescriptor;
 import com.buschmais.xo.neo4j.api.annotation.Label;
-import com.buschmais.xo.neo4j.api.annotation.Property;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
 import com.buschmais.xo.neo4j.api.annotation.Relation.Incoming;
 
-import java.util.List;
-
 /**
  * Interface to describe a named or anonymous function.
  * 
  * @author sh20xyqi
  */
 @Label(value = "Function", usingIndexedPropertyOf = FullQualifiedNameDescriptor.class)
-public interface FunctionDescriptor extends JsDescriptor, FullQualifiedNameDescriptor, CodeArtifact {
-    
-	/**
-     * Returns the name of the function.
-     *
-     * @return The name.
-     */
-	@Property("name")
-    String getName();
-    void setName(String name);
+public interface FunctionDescriptor extends CodeArtifact {
 
     /**
      * Returns all declared {@link FunctionParameterDescriptor} of this function.