org.semanticweb.elk.util.collections.chains.AbstractChain Maven / Gradle / Ivy
package org.semanticweb.elk.util.collections.chains;
import java.util.Map;
/*
* #%L
* ELK Reasoner
* $Id:$
* $HeadURL:$
* %%
* Copyright (C) 2011 - 2012 Department of Computer Science, University of Oxford
* %%
* Licensed under the Apache 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://www.apache.org/licenses/LICENSE-2.0
*
* 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.
* #L%
*/
/**
* This class provides a skeletal implementation of the {@link Chain} interface
* to minimize the effort required to implement this interface. Essentially, one
* has to provide only the implementation of the {@link Link} interface.
*
* @author "Yevgeny Kazakov"
*
* @param
* The type of elements in the chain.
*/
public abstract class AbstractChain> implements
Chain {
@Override
public S find(Matcher matcher) {
T candidate = next();
for (;;) {
if (candidate == null)
return null;
S match = matcher.match(candidate);
if (match != null)
return match;
candidate = candidate.next();
}
}
@Override
public S getCreate(Matcher matcher,
ReferenceFactory factory) {
T candidate = next();
for (;;) {
if (candidate == null) {
S result = factory.create(next());
setNext(result);
return result;
}
S match = matcher.match(candidate);
if (match != null)
return match;
candidate = candidate.next();
}
}
@Override
public S remove(Matcher matcher) {
ModifiableLink point = this;
for (;;) {
T next = point.next();
if (next == null)
return null;
S match = matcher.match(next);
if (match != null) {
point.setNext(next.next());
return match;
}
point = next;
}
}
/**
* Creates a {@link Chain} view of the value associated with the given key
* in the given {@link Map}. The values of the map must be instances of the
* type that can be used in the {@link Chain} interface. All operations with
* the returned {@link Chain}, such as addition or removal, will be
* reflected accordingly in the corresponding value in the {@link Map}.
*
* @param
* the types of the keys of the {@link Map}
* @param
* the types of the values of the {@link Map} and the elements of
* the resulting {@link Chain}
* @param map
* the {@link Map} that backs the data
* @param key
* the key for which to return the {@link Chain} view of the data
* @return the {@link Chain} view of the data associated with key in map
*/
public static > Chain getMapBackedChain(
final Map map, final K key) {
return new AbstractChain() {
@Override
public T next() {
return map.get(key);
}
@Override
public void setNext(T next) {
if (next == null)
map.remove(key);
else
map.put(key, next);
}
};
}
}