VirtualAttribute.java revision d25372dc8e65a9ed019a88fdf659ca61313f1b31
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
* add the following below this CDDL HEADER, with the fields enclosed
* by brackets "[]" replaced with your own identifying information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2008 Sun Microsystems, Inc.
*/
package org.opends.server.types;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import org.opends.server.api.VirtualAttributeProvider;
/**
* This class defines a virtual attribute, which is a special kind of
* attribute whose values do not actually exist in persistent storage
* but rather are computed or otherwise obtained dynamically.
*/
@org.opends.server.types.PublicAPI(
stability = org.opends.server.types.StabilityLevel.VOLATILE,
mayInstantiate = false,
mayExtend = false,
mayInvoke = true)
public final class VirtualAttribute
extends AbstractAttribute
implements Attribute
{
// The attribute type.
private final AttributeType attributeType;
// The entry with which this virtual attribute is associated.
private final Entry entry;
// The virtual attribute provider for this virtual attribute.
private final VirtualAttributeProvider<?> provider;
// The virtual attribute rule for this virtual attribute.
private final VirtualAttributeRule rule;
/**
* Creates a new virtual attribute with the provided information.
*
* @param attributeType
* The attribute type for this virtual attribute.
* @param entry
* The entry in which this virtual attribute exists.
* @param rule
* The virtual attribute rule that governs the behavior of
* this virtual attribute.
*/
public VirtualAttribute(AttributeType attributeType, Entry entry,
VirtualAttributeRule rule)
{
this.attributeType = attributeType;
this.entry = entry;
this.rule = rule;
this.provider = rule.getProvider();
}
/**
* {@inheritDoc}
*/
public ConditionResult approximatelyEqualTo(AttributeValue value)
{
return provider.approximatelyEqualTo(entry, rule, value);
}
/**
* {@inheritDoc}
*/
public boolean contains(AttributeValue value)
{
return provider.hasValue(entry, rule, value);
}
/**
* {@inheritDoc}
*/
@Override
public boolean containsAll(Collection<AttributeValue> values)
{
return provider.hasAllValues(entry, rule, values);
}
/**
* {@inheritDoc}
*/
public AttributeType getAttributeType()
{
return attributeType;
}
/**
* Retrieves the entry in which this virtual attribute exists.
*
* @return The entry in which this virtual attribute exists.
*/
public Entry getEntry()
{
return entry;
}
/**
* {@inheritDoc}
*/
@Override
public String getNameWithOptions()
{
return getName();
}
/**
* {@inheritDoc}
*/
public Set<String> getOptions()
{
return Collections.emptySet();
}
/**
* Retrieves the virtual attribute rule that governs the behavior of
* this virtual attribute.
*
* @return The virtual attribute rule that governs the behavior of
* this virtual attribute.
*/
public VirtualAttributeRule getVirtualAttributeRule()
{
return rule;
}
/**
* {@inheritDoc}
*/
public ConditionResult greaterThanOrEqualTo(AttributeValue value)
{
return provider.greaterThanOrEqualTo(entry, rule, value);
}
/**
* {@inheritDoc}
*/
@Override
public boolean hasAllOptions(Collection<String> options)
{
return (options == null || options.isEmpty());
}
/**
* {@inheritDoc}
*/
@Override
public boolean hasOption(String option)
{
return false;
}
/**
* {@inheritDoc}
*/
@Override
public boolean hasOptions()
{
return false;
}
/**
* {@inheritDoc}
*/
@Override
public boolean isEmpty()
{
return !provider.hasValue(entry, rule);
}
/**
* {@inheritDoc}
*/
public boolean isVirtual()
{
return true;
}
/**
* {@inheritDoc}
*/
public Iterator<AttributeValue> iterator()
{
Set<AttributeValue> values = provider.getValues(entry, rule);
return Collections.unmodifiableSet(values).iterator();
}
/**
* {@inheritDoc}
*/
public ConditionResult lessThanOrEqualTo(AttributeValue value)
{
return provider.lessThanOrEqualTo(entry, rule, value);
}
/**
* {@inheritDoc}
*/
public ConditionResult matchesSubstring(ByteString subInitial,
List<ByteString> subAny, ByteString subFinal)
{
return provider.matchesSubstring(entry, rule, subInitial, subAny,
subFinal);
}
/**
* {@inheritDoc}
*/
@Override
public boolean optionsEqual(Set<String> options)
{
return (options == null || options.isEmpty());
}
/**
* {@inheritDoc}
*/
public int size()
{
return provider.getValues(entry, rule).size();
}
/**
* {@inheritDoc}
*/
public void toString(StringBuilder buffer)
{
buffer.append("VirtualAttribute(");
buffer.append(getAttributeType().getNameOrOID());
buffer.append(", {");
boolean firstValue = true;
for (AttributeValue value : this)
{
if (!firstValue)
{
buffer.append(", ");
}
value.toString(buffer);
firstValue = false;
}
buffer.append("})");
}
}