de.julielab.neo4j.plugins.datarepresentation

Class ImportFacet

java.lang.Object

de.julielab.neo4j.plugins.datarepresentation.ImportFacet

public class ImportFacet
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	customId
protected ImportFacetGroup	facetGroup
protected String	id The database-internal ID which is automatically created.
protected Collection<String>	labels
protected String	name
protected boolean	noFacet
protected String	shortName
protected String	sourceType

Constructor Summary

Constructors

Constructor and Description
ImportFacet(ImportFacetGroup facetGroup, String customId, String name, String shortName, String sourceType) Constructor eligible for creating new facets in the database.
ImportFacet(ImportFacetGroup facetGroup, String customId, String name, String shortName, String sourceType, Collection<String> labels, boolean noFacet) Constructor eligible for creating new facets in the database.
ImportFacet(String id) Constructor used to refer to an existing facet with the given database ID (NOT the custom ID).

Method Summary

Modifier and Type	Method and Description
void	addLabel(String label) Add a label for the resulting Neo4j node.
String	getCustomId()
ImportFacetGroup	getFacetGroup()
String	getId()
Collection<String>	getLabels()
String	getName()
String	getShortName()
String	getSourceType()
boolean	isNoFacet()
void	setCustomId(String customId)
void	setFacetGroup(ImportFacetGroup facetGroup)
void	setId(String id)
void	setLabels(Collection<String> labels)
void	setName(String name)
void	setNoFacet(boolean noFacet)
void	setShortName(String shortName)
void	setSourceType(String sourceType)

Methods inherited from class java.lang.Object

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

Field Detail

customId

protected String customId

See Also:

FacetConstants.PROP_CUSTOM_ID

facetGroup

protected ImportFacetGroup facetGroup

id

protected String id

The database-internal ID which is automatically created. This field should only be set to refer to an already created facet node.

labels

protected Collection<String> labels

name

protected String name

noFacet

protected boolean noFacet

See Also:

FacetConstants.NO_FACET

shortName

protected String shortName

sourceType

protected String sourceType

Constructor Detail

ImportFacet

public ImportFacet(ImportFacetGroup facetGroup,
                   String customId,
                   String name,
                   String shortName,
                   String sourceType)

Constructor eligible for creating new facets in the database.

Parameters:

facetGroup - The group of facets to join this facet to.

customId - A custom ID that can be freely chosen. The only restriction is that it has to be unique within the database.

name - A human-readable name for the facet. Does not need to be unique.

shortName - A short name, optional.

sourceType - The type of the facet contents (hierarchical concepts, flat concepts or arbitrary strings)

ImportFacet

public ImportFacet(ImportFacetGroup facetGroup,
                   String customId,
                   String name,
                   String shortName,
                   String sourceType,
                   Collection<String> labels,
                   boolean noFacet)

Constructor eligible for creating new facets in the database.

Parameters:

facetGroup - The group of facets to join this facet to.

customId - A custom ID that can be freely chosen. The only restriction is that it has to be unique within the database.

name - A human-readable name for the facet. Does not need to be unique.

shortName - A short name, optional.

sourceType - The type of the facet contents (hierarchical concepts, flat concepts or arbitrary strings)

noFacet - Whether or not this facet should go to the default facet group or into the separate "no-facet" section of the database. Used for concepts that should stay hidden most of the time but are used nontheless.

ImportFacet

public ImportFacet(String id)

Constructor used to refer to an existing facet with the given database ID (NOT the custom ID).

Parameters:

id - The automatically created facet ID. Is returned from the database upon facet creation.

Method Detail

addLabel

public void addLabel(String label)

Add a label for the resulting Neo4j node.

Parameters:

label - An arbitrary label.

getCustomId

public String getCustomId()

getFacetGroup

public ImportFacetGroup getFacetGroup()

getId

public String getId()

getLabels

public Collection<String> getLabels()

getName

public String getName()

getShortName

public String getShortName()

getSourceType

public String getSourceType()

isNoFacet

public boolean isNoFacet()

setCustomId

public void setCustomId(String customId)

setFacetGroup

public void setFacetGroup(ImportFacetGroup facetGroup)

setId

public void setId(String id)

setLabels

public void setLabels(Collection<String> labels)

setName

public void setName(String name)

setNoFacet

public void setNoFacet(boolean noFacet)

setShortName

public void setShortName(String shortName)

setSourceType

public void setSourceType(String sourceType)