Author: ssmiweve
Date: 2009-01-27 14:26:41 +0100 (Tue, 27 Jan 2009)
New Revision: 7169
Modified:
branches/2.18/result-spi/src/main/java/no/sesat/search/result/Modifier.java
branches/2.18/result-spi/src/main/java/no/sesat/search/result/Navigator.java
Log:
doc
Modified:
branches/2.18/result-spi/src/main/java/no/sesat/search/result/Modifier.java
===================================================================
--- branches/2.18/result-spi/src/main/java/no/sesat/search/result/Modifier.java
2009-01-27 08:57:39 UTC (rev 7168)
+++ branches/2.18/result-spi/src/main/java/no/sesat/search/result/Modifier.java
2009-01-27 13:26:41 UTC (rev 7169)
@@ -1,4 +1,4 @@
-/* Copyright (2006-2007) Schibsted Søk AS
+/* Copyright (2006-2009) Schibsted Søk AS
* This file is part of SESAT.
*
* SESAT is free software: you can redistribute it and/or modify
@@ -20,9 +20,12 @@
import java.io.Serializable;
import java.util.Comparator;
-/**
+/** A Modifier is a abstraction of a navigator model from a faceted search
command's result.
+ * The configuration bean to this class is the Navigator class.
*
- * @version <tt>$Revision$</tt>
+ * A facet item contains a name, a hitcount, and a refernence to the config
Navigator bean.
+ *
+ * @version <tt>$Id$</tt>
*/
public final class Modifier implements Comparable<Modifier>, Serializable {
Modified:
branches/2.18/result-spi/src/main/java/no/sesat/search/result/Navigator.java
===================================================================
---
branches/2.18/result-spi/src/main/java/no/sesat/search/result/Navigator.java
2009-01-27 08:57:39 UTC (rev 7168)
+++
branches/2.18/result-spi/src/main/java/no/sesat/search/result/Navigator.java
2009-01-27 13:26:41 UTC (rev 7169)
@@ -1,4 +1,4 @@
-/* Copyright (2006-2007) Schibsted Søk AS
+/* Copyright (2006-2009) Schibsted Søk AS
* This file is part of SESAT.
*
* SESAT is free software: you can redistribute it and/or modify
@@ -19,17 +19,14 @@
import java.io.Serializable;
-/** Configuration within a CommandConfig used for manipulating the command's
navigation results.
+/** Configuration within a CommandConfig used to define facets for any facet
supporting search command.
*
+ * Each facet contains an id, name, displayName, sort definition,
boundaryMatch enabled, and children navigators.
*
- * @version <tt>$Revision: 3361 $</tt>
+ * @version <tt>$Id$</tt>
*/
public final class Navigator implements Serializable {
- /**
- * The serialVersionUID
- */
- private static final long serialVersionUID = -3135641813818854457L;
private String name;
private String field;
private Navigator childNavigator;
@@ -71,65 +68,38 @@
boundaryMatch = false;
}
- /**
- *
- */
public Navigator getChildNavigator() {
return childNavigator;
}
- /**
- *
- */
public void setChildNavigator(final Navigator childNavigator) {
this.childNavigator = childNavigator;
}
- /**
- *
- */
public String getName() {
return name;
}
- /**
- *
- */
public void setName(final String name) {
this.name = name;
}
- /**
- *
- */
public String toString() {
return name;
}
- /**
- *
- */
public String getField() {
return field;
}
- /**
- *
- */
public void setField(final String field) {
this.field = field;
}
- /**
- *
- */
public String getDisplayName() {
return displayName;
}
- /**
- *
- */
public void setDisplayName(final String displayName) {
this.displayName = displayName;
}
_______________________________________________
Kernel-commits mailing list
[email protected]
http://sesat.no/mailman/listinfo/kernel-commits
