dialect javadoc

Author: jeanetteclark

src/main/java/edu/ucsb/nceas/mdqengine/model/Dialect.java

@@ -3,19 +3,57 @@
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 
+/**
+ * Dialect is used to conditionally apply the check or ensure Check is valid. They
+ * contain a name, xpath and/or expression element which is used to extract an
+ * element that can be used to verify the check should be run on the document.
+ */
+
 @XmlAccessorType(XmlAccessType.FIELD)
 public interface Dialect {
-
+	/**
+	 * Gets the name of the dialect.
+	 *
+	 * @return the dialect name
+	 */
 	public String getName();
 
+	/**
+	 * Sets the name of the dialect.
+	 *
+	 * @param name the dialect name to set
+	 */
 	public void setName(String name);
 
+	/**
+	 * Gets the xpath expression used to determine if this dialect applies to a
+	 * given metadata document.
+	 *
+	 * @return the xpath expression string
+	 */
 	public String getXpath();
 
+	/**
+	 * Sets the xpath for this dialect.
+	 *
+	 * @param xpath the xpath expression to set
+	 */
 	public void setXpath(String xpath);
 
+	/**
+	 * Gets the expression object used to evaluate the dialect condition. This can
+	 * be used instead of or in addition to xpath to support other expression
+	 * syntaxes.
+	 *
+	 * @return the Expression object
+	 */
 	public Expression getExpression();
 
+	/**
+	 * Sets the expression object. This can be used instead of or in addition to
+	 * xpath to support other expression syntaxes.
+	 *
+	 * @param expression the Expression to set
+	 */
 	public void setExpression(Expression expression);
-
 }

src/main/java/edu/ucsb/nceas/mdqengine/model/DialectV1.java

@@ -4,10 +4,17 @@
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
 
+/**
+ * Dialect is used to conditionally apply the check or ensure Check is valid. They
+ * contain a name, xpath and/or expression element which is used to extract an
+ * element that can be used to verify the check should be run on the document.
+ */
+
 @XmlAccessorType(XmlAccessType.FIELD)
 public class DialectV1 implements Dialect {
 
-    public DialectV1() {}
+    public DialectV1() {
+    }
 
     /**
      * The name or label to associate with this dialect definition
@@ -17,10 +24,8 @@ public DialectV1() {}
 
     /**
      * The XPath expression that is used to determine if a document is of this
-     * dialect.
-     * The expression should evaluate to a boolean value, where true indicates the
-     * document
-     * is of this dialect.
+     * dialect. The expression should evaluate to a boolean value, where true
+     * indicates the document is of this dialect.
      */
     @XmlElement(required = false)
     private String xpath;
@@ -41,14 +46,14 @@ public void setXpath(String xpath) {
         this.xpath = xpath;
     }
 
-	@Override
+    @Override
     public Expression getExpression() {
         return null;
     }
+
     @Override
     public void setExpression(Expression expression) {
         return;
     }
 
-
 }

src/main/java/edu/ucsb/nceas/mdqengine/model/DialectV2.java

@@ -4,45 +4,61 @@
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
 
+/**
+ * Dialect is used to conditionally apply the check or ensure Check is valid.
+ * They
+ * contain a name, xpath and/or expression element which is used to extract an
+ * element that can be used to verify the check should be run on the document.
+ * 
+ * DialectV2 optionally supports the expression element, which allows for more
+ * options in syntax than the previously used xpath element.
+ */
+
 @XmlAccessorType(XmlAccessType.FIELD)
 public class DialectV2 implements Dialect {
 
-	public DialectV2() {}
+	public DialectV2() {
+	}
 
 	public static DialectV2 newDialect() {
-        return new DialectV2();
-    }
-	
+		return new DialectV2();
+	}
+
 	/**
 	 * The name or label to associate with this dialect definition
 	 */
-    @XmlElement(required = false)
+	@XmlElement(required = false)
 	private String name;
-	
+
 	/**
-	 * The XPath expression that is used to determine if a document is of this dialect.
-	 * The expression should evaluate to a boolean value, where true indicates the document 
+	 * The XPath expression that is used to determine if a document is of this
+	 * dialect.
+	 * The expression should evaluate to a boolean value, where true indicates the
+	 * document
 	 * is of this dialect.
 	 */
-    @XmlElement(required = false)
-    private String xpath;
-	
+	@XmlElement(required = false)
+	private String xpath;
+
 	@XmlElement(required = false)
 	private Expression expression;
 
-    @Override
+	@Override
 	public String getName() {
 		return name;
 	}
-    @Override
+
+	@Override
 	public void setName(String name) {
 		this.name = name;
 	}
-    @Override
+
+	@Override
 	public String getXpath() {
 		return xpath;
 	}
-    @Override
+
+	@Override
 	public void setXpath(String xpath) {
 		this.xpath = xpath;
 	}