com.bigdata.rdf.internal.InlinePrefixedSuffixedFixedWidthIntegerURIHandler Maven / Gradle / Ivy

Go to download
/**

Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016.  All rights reserved.

Contact:
     SYSTAP, LLC DBA Blazegraph
     2501 Calvert ST NW #106
     Washington, DC 20008
     [email protected]

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package com.bigdata.rdf.internal;

import com.bigdata.rdf.internal.impl.literal.AbstractLiteralIV;
import com.bigdata.rdf.model.BigdataLiteral;

/**
 * 
 * Utility IV to generate IVs for URIs in the form of http://example.org/value/STRPREFIX1234234513STRSUFFIX
 * where the localName of the URI is a string  prefix followed by a fixed width integer  value followed by a string suffix.
 * 
 * You should extend this class with implementation for specific instances of URIs that follow
 * this form such as:  http://rdf.ncbi.nlm.nih.gov/pubchem/compound/CID_000234_SUFFIX would be
 * created as
 * 
 *  
 * InlinePrefixedSuffixedFixedWidthIntegerURIHandler handler = new InlinePrefixedSuffixedFixedWidthIntegerURIHandler("http://rdf.ncbi.nlm.nih.gov/pubchem/compound/","CID_","_SUFFIX",6)
 *  
 * This has support for overloading on a single namespace {@link InlineLocalNameIntegerURIHandler}. 
 * 
 * @author beebs
 * 
 */

public class InlinePrefixedSuffixedFixedWidthIntegerURIHandler extends
		InlineLocalNameIntegerURIHandler implements IPrefixedURIHandler, ISuffixedURIHandler {

	private String prefix = null;
	private String suffix = null;
	private int width = 0;

	public InlinePrefixedSuffixedFixedWidthIntegerURIHandler(final String namespace,
			final String prefix, final String suffix, final int width) {
		super(namespace);
		this.prefix = prefix;
		this.suffix = suffix;
		this.width = width;
	}

	public InlinePrefixedSuffixedFixedWidthIntegerURIHandler(final String namespace,
			final String prefix, final String suffix, final int width, final int id) {
		super(namespace);
		this.prefix = prefix;
		this.suffix = suffix;
		this.width = width;
		this.packedId = id;
	}

	@Override
	@SuppressWarnings("rawtypes")
	protected AbstractLiteralIV createInlineIV(String localName) {
		if (!localName.startsWith(this.prefix) || !localName.endsWith(suffix)) {
			return null;
		}

		final String intValue = localName.substring(this.prefix.length(),
				localName.length() - this.suffix.length());
				
		return super.createInlineIV(getPackedValueString(intValue));
	}

	@Override
	public String getLocalNameFromDelegate(
			AbstractLiteralIV delegate) {
		final String intStr = super.getLocalNameFromDelegate(delegate);

		final int intVal = (int) getUnpackedValueFromString(intStr);

		return this.prefix  + String.format("%0" + width + "d", intVal) + suffix;
	}

	public String getPrefix() {
		return prefix;
	}

	public String getSuffix() {
		return suffix;
	}
}