Package org.pathvisio.libgpml.prop
Interface Property
- All Known Implementing Classes:
StaticProperty
public interface Property
This interface defines a typed property.
- Author:
- Mark Woon
-
Method Summary
Modifier and Type Method Description java.lang.StringgetDescription()Description of property, used e.g.java.lang.StringgetId()Returns the Id for this property.java.lang.StringgetName()Returns the name of property, used e.g.PropertyTypegetType()Returns the data type for this property.booleanisCollection()Gets whether this property has accepts values.
-
Method Details
-
getId
java.lang.String getId()Returns the Id for this property. Ids must be unique.- Returns:
- the id for this property.
-
getName
java.lang.String getName()Returns the name of property, used e.g. as row header in the properties table.- Returns:
- the name.
-
getDescription
java.lang.String getDescription()Description of property, used e.g. as tooltip text when mousing over the properties table. Descriptions are optional.- Returns:
- description. May return null.
-
getType
PropertyType getType()Returns the data type for this property.- Returns:
- the data property type.
-
isCollection
boolean isCollection()Gets whether this property has accepts values.- Returns:
- true if this property accepts values.
-