/* Copyright 2010 - 2014 by Brian Uri!
This file is part of DDMSence.
This library is free software; you can redistribute it and/or modify
it under the terms of version 3.0 of the GNU Lesser General Public
License as published by the Free Software Foundation.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with DDMSence. If not, see <http://www.gnu.org/licenses/>.
You can contact the author at ddmsence@urizone.net. The DDMSence
home page is located at http://ddmsence.urizone.net/
*/
package buri.ddmsence.ddms.security.ntk;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import nu.xom.Element;
import nu.xom.Elements;
import buri.ddmsence.AbstractAccessEntity;
import buri.ddmsence.AbstractBaseComponent;
import buri.ddmsence.ddms.IBuilder;
import buri.ddmsence.ddms.IDDMSComponent;
import buri.ddmsence.ddms.InvalidDDMSException;
import buri.ddmsence.ddms.security.ism.SecurityAttributes;
import buri.ddmsence.util.DDMSVersion;
import buri.ddmsence.util.LazyList;
import buri.ddmsence.util.Util;
/**
* An immutable implementation of ntk:AccessGroup.
* <br /><br />
* {@ddms.versions 00010}
*
* <p></p>
*
* {@table.header History}
* <p>This class was introduced to support NTK components in DDMS 4.1. Those components are
* no longer a part of DDMS 5.0.</p>
* {@table.footer}
* {@table.header Nested Elements}
* {@child.info ntk:AccessSystemName|1|00010}
* {@child.info ntk:AccessGroupValue|1..*|00010}
* {@table.footer}
* {@table.header Attributes}
* {@child.info ism:classification|1|00010}
* {@child.info ism:ownerProducer|1..*|00010}
* {@child.info ism:<<i>securityAttributes</i>>|0..*|00010}
* {@table.footer}
* {@table.header Validation Rules}
* {@ddms.rule Component must not be used before the DDMS version in which it was introduced.|Error|11111}
* {@ddms.rule The qualified name of this element must be correct.|Error|11111}
* {@ddms.rule ntk:AccessSystemName must exist.|Error|11111}
* {@ddms.rule At least 1 ntk:AccessGroupValue must exist.|Error|11111}
* {@ddms.rule ism:classification must exist.|Error|11111}
* {@ddms.rule ism:ownerProducer must exist.|Error|11111}
* {@table.footer}
*
* @author Brian Uri!
* @since 2.0.0
*/
public final class Group extends AbstractAccessEntity {
private List<GroupValue> _groupValues = null;
/**
* Constructor for creating a component from a XOM Element
*
* @param element the XOM element representing this
* @throws InvalidDDMSException if any required information is missing or malformed
*/
public Group(Element element) throws InvalidDDMSException {
super(element);
try {
Elements values = element.getChildElements(GroupValue.getName(getDDMSVersion()), getNamespace());
_groupValues = new ArrayList<GroupValue>();
for (int i = 0; i < values.size(); i++) {
_groupValues.add(new GroupValue(values.get(i)));
}
validate();
}
catch (InvalidDDMSException e) {
e.setLocator(getQualifiedName());
throw (e);
}
}
/**
* Constructor for creating a component from raw data
*
* @param systemName the system name
* @param groupValues the list of values
* @param securityAttributes security attributes
* @throws InvalidDDMSException if any required information is missing or malformed
*/
public Group(SystemName systemName, List<GroupValue> groupValues, SecurityAttributes securityAttributes)
throws InvalidDDMSException {
super(Group.getName(DDMSVersion.getCurrentVersion()), systemName, securityAttributes);
try {
if (groupValues == null)
groupValues = Collections.emptyList();
for (GroupValue value : groupValues) {
getXOMElement().appendChild(value.getXOMElementCopy());
}
_groupValues = groupValues;
validate();
}
catch (InvalidDDMSException e) {
e.setLocator(getQualifiedName());
throw (e);
}
}
/**
* @see AbstractBaseComponent#validate()
*/
protected void validate() throws InvalidDDMSException {
Util.requireQName(getXOMElement(), getNamespace(), Group.getName(getDDMSVersion()));
if (getGroupValues().isEmpty())
throw new InvalidDDMSException("At least one group value must exist.");
super.validate();
}
/**
* @see AbstractAccessEntity#getOutputName()
*/
protected String getOutputName() {
return ("group");
}
/**
* @see AbstractAccessEntity#getOutputValues()
*/
protected List<?> getOutputValues() {
return (getGroupValues());
}
/**
* @see AbstractBaseComponent#getNestedComponents()
*/
protected List<IDDMSComponent> getNestedComponents() {
List<IDDMSComponent> list = super.getNestedComponents();
list.addAll(getGroupValues());
return (list);
}
/**
* @see Object#equals(Object)
*/
public boolean equals(Object obj) {
if (!super.equals(obj) || !(obj instanceof Group))
return (false);
return (true);
}
/**
* Accessor for the element name of this component, based on the version of DDMS used
*
* @param version the DDMSVersion
* @return an element name
*/
public static String getName(DDMSVersion version) {
Util.requireValue("version", version);
return ("AccessGroup");
}
/**
* Accessor for the list of group values (1-many)
*/
public List<GroupValue> getGroupValues() {
return (Collections.unmodifiableList(_groupValues));
}
/**
* Builder for this DDMS component.
*
* @see IBuilder
* @author Brian Uri!
* @since 2.0.0
*/
public static class Builder extends AbstractAccessEntity.Builder {
private static final long serialVersionUID = 7851044806424206976L;
private List<GroupValue.Builder> _groupValues;
/**
* Empty constructor
*/
public Builder() {
super();
}
/**
* Constructor which starts from an existing component.
*/
public Builder(Group group) {
super(group);
for (GroupValue value : group.getGroupValues())
getGroupValues().add(new GroupValue.Builder(value));
}
/**
* @see IBuilder#commit()
*/
public Group commit() throws InvalidDDMSException {
if (isEmpty())
return (null);
List<GroupValue> values = new ArrayList<GroupValue>();
for (IBuilder builder : getGroupValues()) {
GroupValue component = (GroupValue) builder.commit();
if (component != null)
values.add(component);
}
return (new Group(getSystemName().commit(), values, getSecurityAttributes().commit()));
}
/**
* @see IBuilder#isEmpty()
*/
public boolean isEmpty() {
boolean hasValueInList = false;
for (IBuilder builder : getGroupValues())
hasValueInList = hasValueInList || !builder.isEmpty();
return (!hasValueInList && super.isEmpty());
}
/**
* Builder accessor for the values
*/
public List<GroupValue.Builder> getGroupValues() {
if (_groupValues == null)
_groupValues = new LazyList(GroupValue.Builder.class);
return _groupValues;
}
}
}