org.sakaiproject.hierarchy.model.HierarchyNode Maven / Gradle / Ivy
/**
* Copyright (c) 2007-2014 The Apereo Foundation
*
* Licensed under the Educational Community License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://opensource.org/licenses/ecl2
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* The Apereo Foundation licenses this file to you under the Educational
* Community License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at:
*
* http://opensource.org/licenses/ecl2.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.sakaiproject.hierarchy.model;
import java.util.Set;
/**
* This pea represents a node in a hierarchy
* (in academics a department or college would probably be represented by a node)
*
* @author Aaron Zeckoski ([email protected])
*/
public class HierarchyNode {
/**
* The unique id for this hierarchy node
*/
public String id;
/**
* The assigned unique id for the hierarchy this node is in
*/
public String hierarchyId;
/**
* the title of this node
*/
public String title;
/**
* the description for this node
*/
public String description;
/**
* the permissions token for the associated node,
* can be looked up in the permissions token key generator service
*/
public String permToken;
/**
* a set of all direct parents for this node,
* the ids of parent nodes that touch this node directly
*/
public Set directParentNodeIds;
/**
* a set of all direct children for this node,
* the ids of child nodes that touch this node directly
*/
public Set directChildNodeIds;
/**
* a set of all parents for this node
*/
public Set parentNodeIds;
/**
* a set of all children for this node
*/
public Set childNodeIds;
/**
* boolean representing whether or not node is disabled
*/
public Boolean isDisabled;
/**
* Empty constructor
*/
public HierarchyNode() {}
/**
* Testing constructor
* @param id
* @param hierarchyId
* @param title
* @param permToken
* @param directParentNodeIds
* @param directChildNodeIds
* @param parentNodeIds
* @param childNodeIds
* @param isDisabled
*/
public HierarchyNode(String id, String hierarchyId, String title,
String permToken, Set directParentNodeIds,
Set parentNodeIds, Set directChildNodeIds,
Set childNodeIds, Boolean isDisabled) {
this.id = id;
this.hierarchyId = hierarchyId;
this.title = title;
this.permToken = permToken;
this.directParentNodeIds = directParentNodeIds;
this.parentNodeIds = parentNodeIds;
this.directChildNodeIds = directChildNodeIds;
this.childNodeIds = childNodeIds;
this.isDisabled = isDisabled;
}
/*
* overrides for various internal methods
*/
@Override
public boolean equals(Object obj) {
if (null == obj) return false;
if (!(obj instanceof HierarchyNode)) return false;
else {
HierarchyNode castObj = (HierarchyNode) obj;
if (null == this.id || null == castObj.id) return false;
else return (
this.id.equals(castObj.id) &&
this.hierarchyId.equals(castObj.hierarchyId)
);
}
}
@Override
public int hashCode() {
if (null == this.id) return super.hashCode();
String hashStr = this.getClass().getName() + ":" + this.id.hashCode() + ":" + this.hierarchyId.hashCode();
return hashStr.hashCode();
}
@Override
public String toString() {
return "id:" + this.id + ";hierachyId:" + this.hierarchyId + ";parents:" + this.parentNodeIds.size() + ";children:" + this.childNodeIds.size();
}
}