Package org.obolibrary.robot.export

Class Column

java.lang.Object

org.obolibrary.robot.export.Column

public class Column
extends Object

Author:

Becky Jackson

Constructor Summary

Constructors

Constructor	Description
Column(String name)	Init a new column with a name.
Column(String name, String displayName)	Init a new column with a name and a display name.
Column(String name, String displayName, org.semanticweb.owlapi.model.IRI iri, org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider, String entitySelect)	Init a new Column using an IRI.
Column(String name, String displayName, org.semanticweb.owlapi.model.OWLAnnotationProperty annotationProperty, org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider)	Init a new Column using an annotation property.
Column(String name, String displayName, org.semanticweb.owlapi.model.OWLDataProperty dataProperty, org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider, String entitySelect)	Init a new Column using a data property.
Column(String name, String displayName, org.semanticweb.owlapi.model.OWLObjectProperty objectProperty, org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider, String entitySelect)	Init a new column using an object property.
Column(String name, Map<String,List<String>> rules, String displayRule, org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider)	Init a new column using one or more rules for validate.
Column(String name, org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider)	Init a new column with a name and a provider.

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Get the display name of a column.
String	getDisplayRule()	Get the display rule of a column for validation.
boolean	getIncludeAnonymous()
boolean	getIncludeNamed()
org.semanticweb.owlapi.model.IRI	getIRI()	Return the IRI used in a column, or null.
String	getName()	Get the name of a column.
org.semanticweb.owlapi.model.OWLProperty	getProperty()	Return the OWLProperty used in a column, or null.
Map<String,List<String>>	getRules()	Return the rules used in column for validate, or null.
org.semanticweb.owlapi.util.ShortFormProvider	getShortFormProvider()	Return the short form provider for this column
int	getSortOrder()	Get the int sort order of the column.
boolean	isReverseSort()	Get reverse sort for column.
void	setSort(int sortOrder)	Set the sort order for this column.
void	setSort(int sortOrder, boolean reverseSort)	Set the sort order for this column and if it should be sorted in reverse.

Methods inherited from class java.lang.Object

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

Constructor Detail

Column

public Column(String name)

Init a new column with a name.

Parameters:

name - Column name

Column

public Column(String name,
              String displayName)

Init a new column with a name and a display name.

Parameters:

name - Column name

displayName - Column display name

Column

public Column(String name,
              String displayName,
              @Nonnull
              org.semanticweb.owlapi.model.IRI iri,
              @Nonnull
              org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider,
              @Nonnull
              String entitySelect)

Init a new Column using an IRI.

Parameters:

name - Column name

displayName - Column display name

iri - IRI of column property

shortFormProvider - ShortFormProvider to use when rendering values

entitySelect - String keyword to set includeNamed and includeAnonymous

Column

public Column(String name,
              String displayName,
              @Nonnull
              org.semanticweb.owlapi.model.OWLAnnotationProperty annotationProperty,
              @Nonnull
              org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider)

Init a new Column using an annotation property.

Parameters:

name - Column name

displayName - Column display name

annotationProperty - column OWLAnnotationProperty

shortFormProvider - ShortFormProvider to use when rendering values

Column

public Column(String name,
              String displayName,
              @Nonnull
              org.semanticweb.owlapi.model.OWLDataProperty dataProperty,
              @Nonnull
              org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider,
              @Nonnull
              String entitySelect)

Init a new Column using a data property.

Parameters:

name - Column name

displayName - Column display name

dataProperty - column OWLDataProperty

shortFormProvider - ShortFormProvider to use when rendering values

entitySelect - String keyword to set includeNamed and includeAnonymous

Column

public Column(String name,
              String displayName,
              @Nonnull
              org.semanticweb.owlapi.model.OWLObjectProperty objectProperty,
              @Nonnull
              org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider,
              @Nonnull
              String entitySelect)

Init a new column using an object property.

Parameters:

name - Column name

displayName - Column display name

objectProperty - column OWLObjectProperty

shortFormProvider - ShortFormProvider to use when rendering values

entitySelect - String keyword to set includeNamed and includeAnonymous

Column

public Column(String name,
              @Nonnull
              org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider)

Init a new column with a name and a provider.

Parameters:

name - Column name

shortFormProvider - ShortFormProvider to use when rendering values

Column

public Column(String name,
              Map<String,List<String>> rules,
              String displayRule,
              @Nonnull
              org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider)

Init a new column using one or more rules for validate.

Parameters:

name - Column name

rules - Column rules

displayRule - String raw display rule for output

shortFormProvider - ShortFormProvider for rendering

Method Detail

getDisplayName

public String getDisplayName()

Get the display name of a column.

Returns:

String display name

getDisplayRule

public String getDisplayRule()

Get the display rule of a column for validation.

Returns:

String display rule

getName

public String getName()

Get the name of a column.

Returns:

String name of column

getProperty

@Nullable
public org.semanticweb.owlapi.model.OWLProperty getProperty()

Return the OWLProperty used in a column, or null.

Returns:

OWLProperty or null

getIncludeAnonymous

public boolean getIncludeAnonymous()

Returns:

true if including anonymous entities in this column

getIncludeNamed

public boolean getIncludeNamed()

Returns:

true if including named entities in this column

getIRI

@Nullable
public org.semanticweb.owlapi.model.IRI getIRI()

Return the IRI used in a column, or null.

Returns:

IRI or null

getRules

@Nullable
public Map<String,List<String>> getRules()

Return the rules used in column for validate, or null.

Returns:

map of rules or null

getShortFormProvider

public org.semanticweb.owlapi.util.ShortFormProvider getShortFormProvider()

Return the short form provider for this column

Returns:

ShortFormProvider

getSortOrder

public int getSortOrder()

Get the int sort order of the column.

Returns:

int sort order

isReverseSort

public boolean isReverseSort()

Get reverse sort for column.

Returns:

boolean reverse sort

setSort

public void setSort(int sortOrder)

Set the sort order for this column.

Parameters:

sortOrder - int sort order (starting at 0)

setSort

public void setSort(int sortOrder,
                    boolean reverseSort)

Set the sort order for this column and if it should be sorted in reverse.

Parameters:

sortOrder - int sort order (starting at 0)

reverseSort - if true, sort in reverse