E
- payload of the external field schemapublic class ExternalFieldSchema<E> extends ExternalFieldSchemaTemplate<E>
Constructor and Description |
---|
ExternalFieldSchema(java.lang.String name,
java.lang.String displayname,
java.lang.String tooltip,
StoredTableSchema parent,
JoinQueryConditionDefinition<?> joinqueryconditiondefinition,
int priority,
int displaycolumn)
creates an external field schema with specified priority and display column
|
ExternalFieldSchema(java.lang.String name,
java.lang.String displayname,
java.lang.String tooltip,
StoredTableSchema parent,
StoredFieldSchema<E> externalfield,
boolean richtext,
JoinQueryConditionDefinition<?> joinqueryconditiondefinition,
DisplayProfile<?> hideifprofileset,
int priority,
int displaycolumn)
Creates an external field, potentially formatting it as rich text
|
ExternalFieldSchema(java.lang.String name,
java.lang.String displayname,
java.lang.String tooltip,
StoredTableSchema parent,
StoredFieldSchema<E> externalfield,
FieldChoiceDefinition<?> fieldchoice,
JoinQueryConditionDefinition<?> joinqueryconditiondefinition,
DisplayProfile<?> hideifprofileset,
int priority,
int displaycolumn)
Creates an external field with the specified field choice for formatting
|
ExternalFieldSchema(java.lang.String name,
java.lang.String displayname,
java.lang.String tooltip,
StoredTableSchema parent,
StoredFieldSchema<E> externalfield,
FieldChoiceDefinition<?> fieldchoice,
JoinQueryConditionDefinition<?> joinqueryconditiondefinition,
int priority,
int displaycolumn)
Creates an external field with the specified field choice for formatting
|
ExternalFieldSchema(java.lang.String name,
java.lang.String displayname,
java.lang.String tooltip,
StoredTableSchema parent,
StoredFieldSchema<E> externalfield,
JoinQueryConditionDefinition<?> joinqueryconditiondefinition,
DisplayProfile<?> hideifprofileset,
int priority,
int displaycolumn)
Creates an external field with a condition for profile set
|
ExternalFieldSchema(java.lang.String name,
java.lang.String displayname,
java.lang.String tooltip,
StoredTableSchema parent,
StoredFieldSchema<E> externalfield,
JoinQueryConditionDefinition<?> joinqueryconditiondefinition,
DisplayProfile<?> hideifprofileset,
int priority,
int displaycolumn,
boolean orderedasnumber,
int numberoffset)
creates an external field ordered as a number (with prefix discarded)
|
ExternalFieldSchema(java.lang.String name,
java.lang.String displayname,
java.lang.String tooltip,
StoredTableSchema parent,
StoredFieldSchema<E> externalfield,
JoinQueryConditionDefinition<?> joinqueryconditiondefinition,
int priority,
int displaycolumn) |
Modifier and Type | Method and Description |
---|---|
void |
addSpecialdisplaynamewhenprofileactive(DisplayProfile<?> profile,
java.lang.String specialdisplayname)
changes the display is a profile is active.
|
void |
addStoredField(StoredFieldSchema<E> externalfield) |
E |
castToType(java.lang.Object o) |
E |
defaultValue() |
int |
getDisplaycolumn() |
java.lang.String |
getDisplayname() |
java.lang.String |
getDisplayName(NamedList<DisplayProfile<?>> activeprofiles)
gets the display name depending on display profile
|
java.util.ArrayList<StoredFieldSchema<E>> |
getExternalTableField() |
FieldChoiceDefinition<?> |
getFieldChoice()
gets the field choice definition if set on the field
|
DisplayProfile<?> |
getHideProfile()
gets the display profile representing the hidden fields
|
JoinQueryConditionDefinition<?> |
getJoinqueryconditiondefinition()
gets the join query condition to get from the main table to the appendix
table
|
int |
getNumberOffsetForOrdering()
gives the number offset (size of prefix) for ordering
|
int |
getPriority() |
java.lang.String |
getTooltip() |
Field<E> |
initBlankField()
this method returns a subclass of Field appropriate for the field schema
|
boolean |
isDiplayInBottomNotes() |
boolean |
isDisplayInTitle() |
boolean |
isOrderedAsInteger()
tells if the field should be ordered as integer (removing prefix)
|
boolean |
isRichText() |
void |
setDisplayInBottomNotes()
if this method is called, the field is displayed in bottom notes
|
void |
setDisplayInTitle()
if this method is called, the field is displayed in title
|
toString
changeName, cleanName, equals, getName
public ExternalFieldSchema(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, StoredTableSchema parent, StoredFieldSchema<E> externalfield, JoinQueryConditionDefinition<?> joinqueryconditiondefinition, int priority, int displaycolumn)
name
- name of the fielddisplayname
- display name of the fieldtooltip
- tooltip for mouse roll-overparent
- parent table (the external table from
which the field is extracted)externalfield
- name of the field from the external
stored tablejoinqueryconditiondefinition
- join query condition to get from the main
object table to an appendix tablepriority
- a number from -1000 to 1000 (excluded)displaycolumn
- size of the column when displayed in
tablepublic ExternalFieldSchema(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, StoredTableSchema parent, JoinQueryConditionDefinition<?> joinqueryconditiondefinition, int priority, int displaycolumn)
name
- name of the fielddisplayname
- display name of the fieldtooltip
- tooltip for mouse roll-overparent
- parent table (the external table from
which the field is extractedjoinqueryconditiondefinition
- join query condition to get from the main
object table to an appendix tablepriority
- a number from -1000 to 1000 (excluded)displaycolumn
- size of the column when displayed in
tablepublic ExternalFieldSchema(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, StoredTableSchema parent, StoredFieldSchema<E> externalfield, JoinQueryConditionDefinition<?> joinqueryconditiondefinition, DisplayProfile<?> hideifprofileset, int priority, int displaycolumn)
name
- name of the fielddisplayname
- display name of the fieldtooltip
- tooltip for mouse roll-overparent
- parent table (the external table from
which the field is extractedexternalfield
- joinqueryconditiondefinition
- join query condition to get from the main
object table to an appendix tablehideifprofileset
- preset profile for which the field will
be hidden if profile active on the
projectpriority
- a number from -1000 to 1000 (excluded)displaycolumn
- size of the column when displayed in
tablepublic ExternalFieldSchema(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, StoredTableSchema parent, StoredFieldSchema<E> externalfield, boolean richtext, JoinQueryConditionDefinition<?> joinqueryconditiondefinition, DisplayProfile<?> hideifprofileset, int priority, int displaycolumn)
name
- name of the fielddisplayname
- display name of the fieldtooltip
- tooltip for mouse roll-overparent
- parent table (the external table from
which the field is extractedexternalfield
- definition of the external fieldrichtext
- true if field is rich textjoinqueryconditiondefinition
- join query condition to get from the main
object table to an appendix tablehideifprofileset
- preset profile for which the field will
be hidden if profile active on the
projectpriority
- a number from -1000 to 1000 (excluded)displaycolumn
- size of the column when displayed in
tablepublic ExternalFieldSchema(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, StoredTableSchema parent, StoredFieldSchema<E> externalfield, JoinQueryConditionDefinition<?> joinqueryconditiondefinition, DisplayProfile<?> hideifprofileset, int priority, int displaycolumn, boolean orderedasnumber, int numberoffset)
name
- name of the fielddisplayname
- display name of the fieldtooltip
- tooltip for mouse roll-overparent
- parent table (the external table from
which the field is extractedexternalfield
- definition of the external fieldjoinqueryconditiondefinition
- join query condition to get from the main
object table to an appendix tablehideifprofileset
- preset profile for which the field will
be hidden if profile active on the
projectpriority
- a number from -1000 to 1000 (excluded)displaycolumn
- size of the column when displayed in
tableorderedasnumber
- true if ordered as numbernumberoffset
- number offsetpublic ExternalFieldSchema(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, StoredTableSchema parent, StoredFieldSchema<E> externalfield, FieldChoiceDefinition<?> fieldchoice, JoinQueryConditionDefinition<?> joinqueryconditiondefinition, int priority, int displaycolumn)
name
- name of the fielddisplayname
- display name of the fieldtooltip
- tooltip for mouse roll-overparent
- parent table (the external table from
which the field is extractedexternalfield
- definition of the external fieldfieldchoice
- choice definitionjoinqueryconditiondefinition
- join query condition to get from the main
object table to an appendix tablepriority
- a number from -1000 to 1000 (excluded)displaycolumn
- size of the column when displayed in
tablepublic ExternalFieldSchema(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, StoredTableSchema parent, StoredFieldSchema<E> externalfield, FieldChoiceDefinition<?> fieldchoice, JoinQueryConditionDefinition<?> joinqueryconditiondefinition, DisplayProfile<?> hideifprofileset, int priority, int displaycolumn)
name
- name of the fielddisplayname
- display name of the fieldtooltip
- tooltip for mouse roll-overparent
- parent table (the external table from
which the field is extractedexternalfield
- definition of the external fieldfieldchoice
- choice definitionjoinqueryconditiondefinition
- join query condition to get from the main
object table to an appendix tablehideifprofileset
- preset profile for which the field will
be hidden if profile active on the
projectpriority
- specific priority from -1000 to 1000
(excluded)displaycolumn
- size of the column when displayed in
tablepublic boolean isOrderedAsInteger()
public int getNumberOffsetForOrdering()
public void setDisplayInTitle()
public void setDisplayInBottomNotes()
public boolean isDisplayInTitle()
public boolean isDiplayInBottomNotes()
public int getPriority()
public int getDisplaycolumn()
public boolean isRichText()
public java.lang.String getDisplayName(NamedList<DisplayProfile<?>> activeprofiles)
activeprofiles
- list of active profilespublic DisplayProfile<?> getHideProfile()
public FieldChoiceDefinition<?> getFieldChoice()
public JoinQueryConditionDefinition<?> getJoinqueryconditiondefinition()
public java.util.ArrayList<StoredFieldSchema<E>> getExternalTableField()
getExternalTableField
in class ExternalFieldSchemaTemplate<E>
public void addStoredField(StoredFieldSchema<E> externalfield)
externalfield
- public void addSpecialdisplaynamewhenprofileactive(DisplayProfile<?> profile, java.lang.String specialdisplayname)
profile
- profile for which the display is specialspecialdisplayname
- special display namepublic E castToType(java.lang.Object o)
castToType
in class FieldSchema<E>
o
- an uncasted objectpublic E defaultValue()
defaultValue
in class FieldSchema<E>
public Field<E> initBlankField()
FieldSchema
initBlankField
in class FieldSchema<E>
public java.lang.String getTooltip()
public java.lang.String getDisplayname()