org.semanticweb.binaryowl

Class BinaryOWLMetadata

java.lang.Object

org.semanticweb.binaryowl.BinaryOWLMetadata

public class BinaryOWLMetadata
extends Object

Author: Matthew Horridge
Stanford University
Bio-Medical Informatics Research Group
Date: 08/05/2012

A structure for holding key value pairs that can be serialized in a binary format. The values may take the form of primitive types: string, int, long, boolean, double, byte array, or may also be instances of .

Constructor Summary

Constructors

Constructor and Description
BinaryOWLMetadata()
BinaryOWLMetadata(BinaryOWLInputStream inputStream)

Method Summary

Modifier and Type	Method and Description
BinaryOWLMetadata	createCopy() Creates a copy of this metadata object.
static BinaryOWLMetadata	emptyMetadata()
Boolean	getBooleanAttribute(String name, Boolean defaultValue) Gets the boolean value of an attribute.
byte[]	getByteArrayAttribute(String name, byte[] defaultValue) Gets the byte [] value of an attribute.
Double	getDoubleAttribute(String name, Double defaultValue) Gets the double value of an attribute.
Integer	getIntAttribute(String name, Integer defaultValue) Gets the int value of an attribute.
Long	getLongAttribute(String name, Long defaultValue) Gets the long value of an attribute.
List<org.semanticweb.owlapi.model.OWLObject>	getOWLObjectListAttribute(String name, List<org.semanticweb.owlapi.model.OWLObject> defaultValue) Gets the OWLObject list value of an attribute.
String	getStringAttribute(String name, String defaultValue) Gets the string value of an attribute.
boolean	isEmpty()
void	removeAll() Removes all attributes in this metadata object.
void	removeAttribute(String name) Removes all types (int, string, long etc.) of attributes with the specified name.
void	removeBooleanAttribute(String name) Removes a boolean attribute with the specified name.
void	removeByteArrayAttribute(String name) Removes a byte [] attribute with the specified name.
void	removeDoubleAttribute(String name) Removes a double attribute with the specified name.
void	removeIntAttribute(String name) Removes an int attribute with the specified name.
void	removeLongAttribute(String name) Removes a long attribute with the specified name.
void	removeOWLObjectListAttribute(String name) Removes an OWLObject list attribute with the specified name.
void	removeStringAttribute(String name) Removes a string attribute with the specified name.
void	setBooleanAttribute(String name, boolean value) Sets the boolean value for the specified attribute name.
void	setByteArrayAttribute(String name, byte[] value) Sets the byte [] value for the specified attribute name.
void	setDoubleAttribute(String name, double value) Sets the double value for the specified attribute name.
void	setIntAttribute(String name, int value) Sets the integer value for the specified attribute name.
void	setLongAttribute(String name, long value) Sets the long value for the specified attribute name.
void	setOWLObjectListAttribute(String name, List<org.semanticweb.owlapi.model.OWLObject> value) Sets the OWLObject list values for an attribute.
void	setStringAttribute(String name, String value) Sets the string value of an attribute.
String	toString()
void	write(BinaryOWLOutputStream outputStream)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BinaryOWLMetadata

public BinaryOWLMetadata()

BinaryOWLMetadata

public BinaryOWLMetadata(BinaryOWLInputStream inputStream)
                  throws IOException,
                         BinaryOWLParseException

Throws:

IOException

BinaryOWLParseException

Method Detail

isEmpty

public boolean isEmpty()

createCopy

public BinaryOWLMetadata createCopy()

Creates a copy of this metadata object. Modifications to this object don't affect the copy, and vice versa.

Returns:

A copy of this metadata object.

removeAll

public void removeAll()

Removes all attributes in this metadata object.

removeAttribute

public void removeAttribute(String name)

Removes all types (int, string, long etc.) of attributes with the specified name.

Parameters:

name - The name.

getStringAttribute

public String getStringAttribute(String name,
                                 String defaultValue)

Gets the string value of an attribute.

Parameters:

name - The name of the attribute. Not null.

defaultValue - The default value for the attribute. May be null. This value will be returned if this metadata object does not contain a string value for the specified attribute name.

Returns:

Either the string value of the attribute with the specified name, or the value specified by the defaultValue object if this metadata object does not contain a string value for the specified attribute name.

Throws:

NullPointerException - if name is null.

setStringAttribute

public void setStringAttribute(String name,
                               String value)

Sets the string value of an attribute.

Parameters:

name - The name of the attribute. Not null.

value - The value of the attribute. Not null.

Throws:

NullPointerException - if the name parameter, or the value parameter is null.

removeStringAttribute

public void removeStringAttribute(String name)

Removes a string attribute with the specified name.

Parameters:

name - The name of the attribute. Not null.

Throws:

NullPointerException - if the name parameter is null.

setIntAttribute

public void setIntAttribute(String name,
                            int value)

Sets the integer value for the specified attribute name.

Parameters:

name - The name of the attribute. Not null.

value - The value of the attribute to set.

Throws:

NullPointerException - if the name parameter is null.

getIntAttribute

public Integer getIntAttribute(String name,
                               Integer defaultValue)

Gets the int value of an attribute.

Parameters:

name - The name of the attribute. Not null.

defaultValue - The default value for the attribute. May be null. This value will be returned if this metadata object does not contain an int value for the specified attribute name.

Returns:

Either the int value of the attribute with the specified name, or the value specified by the defaultValue object if this metadata object does not contain an int value for the specified attribute name.

Throws:

NullPointerException - if name is null.

removeIntAttribute

public void removeIntAttribute(String name)

Removes an int attribute with the specified name.

Parameters:

name - The name of the attribute. Not null.

Throws:

NullPointerException - if the name parameter is null.

setLongAttribute

public void setLongAttribute(String name,
                             long value)

Sets the long value for the specified attribute name.

Parameters:

name - The name of the attribute. Not null.

value - The value of the attribute to set.

Throws:

NullPointerException - if the name parameter is null.

getLongAttribute

public Long getLongAttribute(String name,
                             Long defaultValue)

Gets the long value of an attribute.

Parameters:

name - The name of the attribute. Not null.

defaultValue - The default value for the attribute. May be null. This value will be returned if this metadata object does not contain a long value for the specified attribute name.

Returns:

Either the long value of the attribute with the specified name, or the value specified by the defaultValue object if this metadata object does not contain a long value for the specified attribute name.

Throws:

NullPointerException - if name is null.

removeLongAttribute

public void removeLongAttribute(String name)

Removes a long attribute with the specified name.

Parameters:

name - The name of the attribute. Not null.

Throws:

NullPointerException - if the name parameter is null.

setBooleanAttribute

public void setBooleanAttribute(String name,
                                boolean value)

Sets the boolean value for the specified attribute name.

Parameters:

name - The name of the attribute. Not null.

value - The value of the attribute to set.

Throws:

NullPointerException - if the name parameter is null.

getBooleanAttribute

public Boolean getBooleanAttribute(String name,
                                   Boolean defaultValue)

Gets the boolean value of an attribute.

Parameters:

name - The name of the attribute. Not null.

defaultValue - The default value for the attribute. May be null. This value will be returned if this metadata object does not contain a boolean value for the specified attribute name.

Returns:

Either the boolean value of the attribute with the specified name, or the value specified by the defaultValue object if this metadata object does not contain a boolean value for the specified attribute name.

Throws:

NullPointerException - if name is null.

removeBooleanAttribute

public void removeBooleanAttribute(String name)

Removes a boolean attribute with the specified name.

Parameters:

name - The name of the attribute. Not null.

Throws:

NullPointerException - if the name parameter is null.

setDoubleAttribute

public void setDoubleAttribute(String name,
                               double value)

Sets the double value for the specified attribute name.

Parameters:

name - The name of the attribute. Not null.

value - The value of the attribute to set.

Throws:

NullPointerException - if the name parameter is null.

getDoubleAttribute

public Double getDoubleAttribute(String name,
                                 Double defaultValue)

Gets the double value of an attribute.

Parameters:

name - The name of the attribute. Not null.

defaultValue - The default value for the attribute. May be null. This value will be returned if this metadata object does not contain a double value for the specified attribute name.

Returns:

Either the double value of the attribute with the specified name, or the value specified by the defaultValue object if this metadata object does not contain a double value for the specified attribute name.

Throws:

NullPointerException - if name is null.

removeDoubleAttribute

public void removeDoubleAttribute(String name)

Removes a double attribute with the specified name.

Parameters:

name - The name of the attribute. Not null.

Throws:

NullPointerException - if the name parameter is null.

setByteArrayAttribute

public void setByteArrayAttribute(String name,
                                  byte[] value)

Sets the byte [] value for the specified attribute name. This parameter will be copied so that modifications to the passed in parameter are not reflected in the storage of the parameter in this metadata object.

Parameters:

name - The name of the attribute. Not null.

value - The value of the attribute to set.

Throws:

NullPointerException - if the name parameter is null or if the value parameter is null.

getByteArrayAttribute

public byte[] getByteArrayAttribute(String name,
                                    byte[] defaultValue)

Gets the byte [] value of an attribute. This will be a copy of the actual byte [] stored in this metadata object, hence modifications to the return value will not affect the stored value.

Parameters:

name - The name of the attribute. Not null.

defaultValue - The default value for the attribute. May be null. This value will be returned if this metadata object does not contain a byte [] value for the specified attribute name.

Returns:

Either the byte [] value of the attribute with the specified name, or the value specified by the defaultValue object if this metadata object does not contain a byte [] value for the specified attribute name.

Throws:

NullPointerException - if name is null.

removeByteArrayAttribute

public void removeByteArrayAttribute(String name)

Removes a byte [] attribute with the specified name.

Parameters:

name - The name of the attribute. Not null.

Throws:

NullPointerException - if the name parameter is null.

getOWLObjectListAttribute

public List<org.semanticweb.owlapi.model.OWLObject> getOWLObjectListAttribute(String name,
                                                                              List<org.semanticweb.owlapi.model.OWLObject> defaultValue)

Gets the OWLObject list value of an attribute.

Parameters:

name - The name of the attribute. Not null.

defaultValue - The default value for the attribute. May be null. This value will be returned if this metadata object does not contain an OWLObject list value for the specified attribute name.

Returns:

Either the OWLObject list value of the attribute with the specified name, or the value specified by the defaultValue object if this metadata object does not contain an OWLObject list value for the specified attribute name.

Throws:

NullPointerException - if name is null.

setOWLObjectListAttribute

public void setOWLObjectListAttribute(String name,
                                      List<org.semanticweb.owlapi.model.OWLObject> value)

Sets the OWLObject list values for an attribute.

Parameters:

name - The name of the attribute. Not null.

value - The value of the attribute. Not null.

Throws:

NullPointerException - if name is null or value is null.

removeOWLObjectListAttribute

public void removeOWLObjectListAttribute(String name)

Removes an OWLObject list attribute with the specified name.

Parameters:

name - The name of the attribute. Not null.

Throws:

NullPointerException - if the name parameter is null.

write

public void write(BinaryOWLOutputStream outputStream)
           throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

emptyMetadata

public static BinaryOWLMetadata emptyMetadata()