Merge pull request #404 from katarinaking/842
MNEMONIC-842: Editing on VMemKingSeriveImpl
diff --git a/mnemonic-core/src/main/java/org/apache/mnemonic/query/memory/AttributeInfo.java b/mnemonic-core/src/main/java/org/apache/mnemonic/query/memory/AttributeInfo.java
index c767604..2b51ed8 100644
--- a/mnemonic-core/src/main/java/org/apache/mnemonic/query/memory/AttributeInfo.java
+++ b/mnemonic-core/src/main/java/org/apache/mnemonic/query/memory/AttributeInfo.java
@@ -18,45 +18,94 @@
import org.apache.mnemonic.DurableType;
+/**
+ * Represents metadata information about an attribute in a durable query.
+ * This class encapsulates details such as the attribute's name, type,
+ * sort order, and an associated entity field identifier.
+ */
public class AttributeInfo {
- private String name;
+ // Name of the attribute
+ private String name;
- private DurableType type;
+ // Durable type of the attribute, indicating its data type
+ private DurableType type;
- private SortOrder sortOrder;
+ // Sort order for the attribute (e.g., ASCENDING or DESCENDING)
+ private SortOrder sortOrder;
- private long entityFieldId;
+ // Identifier for the entity field this attribute is associated with
+ private long entityFieldId;
- public String getName() {
- return name;
- }
+ /**
+ * Retrieves the name of the attribute.
+ *
+ * @return the name of the attribute
+ */
+ public String getName() {
+ return name;
+ }
- public void setName(String name) {
- this.name = name;
- }
+ /**
+ * Sets the name of the attribute.
+ *
+ * @param name the new name for the attribute
+ */
+ public void setName(String name) {
+ this.name = name;
+ }
- public SortOrder getSortOrder() {
- return sortOrder;
- }
+ /**
+ * Retrieves the sort order for this attribute.
+ *
+ * @return the sort order (e.g., ASCENDING or DESCENDING)
+ */
+ public SortOrder getSortOrder() {
+ return sortOrder;
+ }
- public void setSortOrder(SortOrder sortOrder) {
- this.sortOrder = sortOrder;
- }
+ /**
+ * Sets the sort order for this attribute.
+ *
+ * @param sortOrder the sort order to be set
+ */
+ public void setSortOrder(SortOrder sortOrder) {
+ this.sortOrder = sortOrder;
+ }
- public DurableType getType() {
- return type;
- }
+ /**
+ * Retrieves the type of the attribute.
+ *
+ * @return the durable type of the attribute
+ */
+ public DurableType getType() {
+ return type;
+ }
- public void setType(DurableType type) {
- this.type = type;
- }
+ /**
+ * Sets the type of the attribute.
+ *
+ * @param type the durable type to be set
+ */
+ public void setType(DurableType type) {
+ this.type = type;
+ }
- public long getEntityFieldId() {
- return entityFieldId;
- }
+ /**
+ * Retrieves the identifier for the associated entity field.
+ *
+ * @return the entity field identifier
+ */
+ public long getEntityFieldId() {
+ return entityFieldId;
+ }
- public void setEntityFieldId(long entityFieldId) {
- this.entityFieldId = entityFieldId;
- }
+ /**
+ * Sets the identifier for the associated entity field.
+ *
+ * @param entityFieldId the new identifier for the entity field
+ */
+ public void setEntityFieldId(long entityFieldId) {
+ this.entityFieldId = entityFieldId;
+ }
}