|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Objectcom.yosokumo.core.YosokumoProtobuf
class YosokumoProtobuf
Implements all functionality for transforming HTTP entity bytes in Google
Protocol Buffer form into Yosokumo Java objects (e.g., Catalog and
Study) and vice versa. In general there are six functions for
each Yosokumo class, illustrated here for Study:
Converting from HTTP entity bytes to Study:
public Study makeStudyFromBytes (byte [] studyAsBytes) private ProtoBuf.Study makeProtobufStudyFromBytes(byte [] studyAsBytes) private Study makeStudyFromProtobufStudy(ProtoBuf.Study protoStudy)Converting from Study to HTTP entity bytes:
public byte [] makeBytesFromStudy (Study study) private ProtoBuf.Study makeProtobufStudyFromStudy(Study study) private byte [] makeBytesFromProtobufStudy(ProtoBuf.Study protoStudy)Note how Google Protocol Buffer objects are used as the intermediaries between HTTP entity bytes and Yosokumo objects. Here is another view of the transformations done by the functions shown above:
makeStudyFromBytes:
byte [] -> makeProtobufStudyFromBytes -> ProtoBuf.Study
ProtoBuf.Study -> makeStudyFromProtobufStudy -> Study
makeBytesFromStudy:
Study -> makeProtobufStudyFromStudy -> ProtoBuf.Study
ProtoBuf.Study -> makeBytesFromProtobufStudy -> byte []
| Field Summary | |
|---|---|
private ServiceException |
exception
|
| Constructor Summary | |
|---|---|
YosokumoProtobuf()
|
|
| Method Summary | |
|---|---|
java.lang.String |
getContentType()
Return a content type string for use in Accept and Content-Type HTTP header lines. |
ServiceException |
getException()
Return a ServiceException from the code-decode process. |
private com.yosokumo.core.protobuf.ProtoBuf.Predictor.Level |
levelToProtobufLevel(Predictor.Level level)
|
Block |
makeBlockFromBytes(byte[] blockAsBytes)
Make a Yosokumo Block object out of the bytes of an HTTP
Entity. |
private Block |
makeBlockFromProtobufBlock(com.yosokumo.core.protobuf.ProtoBuf.Block protoBlock)
|
byte[] |
makeBytesFromBlock(Block block)
Make the bytes for an HTTP Entity out of a Yosokumo Block
object. |
byte[] |
makeBytesFromCell(Cell cell)
Make the bytes for an HTTP Entity out of a Yosokumo Cell
object. |
byte[] |
makeBytesFromPredictor(Predictor predictor)
Make the bytes for an HTTP Entity out of a Yosokumo Predictor
object. |
private byte[] |
makeBytesFromProtobufBlock(com.yosokumo.core.protobuf.ProtoBuf.Block protoBlock)
|
private byte[] |
makeBytesFromProtobufCell(com.yosokumo.core.protobuf.ProtoBuf.Cell protoCell)
|
private byte[] |
makeBytesFromProtobufPredictor(com.yosokumo.core.protobuf.ProtoBuf.Predictor protoPredictor)
|
private byte[] |
makeBytesFromProtobufRole(com.yosokumo.core.protobuf.ProtoBuf.Role protoRole)
|
private byte[] |
makeBytesFromProtobufSpecimen(com.yosokumo.core.protobuf.ProtoBuf.Specimen protoSpecimen)
|
private byte[] |
makeBytesFromProtobufStatusControl(com.yosokumo.core.protobuf.ProtoBuf.Panel.StatusControl protoStatusControl)
|
private byte[] |
makeBytesFromProtobufStudy(com.yosokumo.core.protobuf.ProtoBuf.Study protoStudy)
|
private byte[] |
makeBytesFromProtobufStudyNameControl(com.yosokumo.core.protobuf.ProtoBuf.Panel.StudyNameControl protoNameControl)
|
private byte[] |
makeBytesFromProtobufVisibilityControl(com.yosokumo.core.protobuf.ProtoBuf.Panel.VisibilityControl protoVisibilityControl)
|
byte[] |
makeBytesFromRole(Role role)
Make the bytes for an HTTP Entity out of a Yosokumo Role
object. |
byte[] |
makeBytesFromSpecimen(Specimen specimen)
Make the bytes for an HTTP Entity out of a Yosokumo Specimen
object. |
byte[] |
makeBytesFromStudy(Study study)
Make the bytes for an HTTP Entity out of a Yosokumo Study
object. |
byte[] |
makeBytesFromStudyName(java.lang.String name)
Make the bytes for an HTTP Entity out of a Yosokumo Study
name. |
byte[] |
makeBytesFromStudyStatus(Study.Status status)
Make the bytes for an HTTP Entity out of a Yosokumo Study
status. |
byte[] |
makeBytesFromStudyVisibility(Study.Visibility visibility)
Make the bytes for an HTTP Entity out of a Yosokumo Study
visibility. |
Catalog |
makeCatalogFromBytes(byte[] catalogAsBytes)
Make a Yosokumo Catalog object out of the bytes of an HTTP
Entity. |
private Catalog |
makeCatalogFromProtobufCatalog(com.yosokumo.core.protobuf.ProtoBuf.Catalog protoCatalog)
|
Cell |
makeCellFromBytes(byte[] cellAsBytes)
Make a Yosokumo Cell object out of the bytes of an HTTP
Entity. |
private Cell |
makeCellFromProtobufCell(com.yosokumo.core.protobuf.ProtoBuf.Cell protoCell)
|
Message |
makeMessageFromBytes(byte[] messageAsBytes)
Make a Yosokumo Message object out of the bytes of an HTTP
Entity. |
private Message |
makeMessageFromProtobufMessage(com.yosokumo.core.protobuf.ProtoBuf.Message protoMessage)
|
Panel |
makePanelFromBytes(byte[] panelAsBytes)
Make a Yosokumo Panel object out of the bytes of an HTTP
Entity. |
private Panel |
makePanelFromProtobufPanel(com.yosokumo.core.protobuf.ProtoBuf.Panel protoPanel)
|
Predictor |
makePredictorFromBytes(byte[] predictorAsBytes)
Make a Yosokumo Predictor object out of the bytes of an HTTP
Entity. |
private Predictor |
makePredictorFromProtobufPredictor(com.yosokumo.core.protobuf.ProtoBuf.Predictor protoPredictor)
|
private com.yosokumo.core.protobuf.ProtoBuf.Block |
makeProtobufBlockFromBlock(Block block)
|
private com.yosokumo.core.protobuf.ProtoBuf.Block |
makeProtobufBlockFromBytes(byte[] blockAsBytes)
|
private com.yosokumo.core.protobuf.ProtoBuf.Catalog |
makeProtobufCatalogFromBytes(byte[] catalogAsBytes)
|
private com.yosokumo.core.protobuf.ProtoBuf.Cell |
makeProtobufCellFromBytes(byte[] cellAsBytes)
|
private com.yosokumo.core.protobuf.ProtoBuf.Cell |
makeProtobufCellFromCell(Cell cell)
|
private com.yosokumo.core.protobuf.ProtoBuf.Message |
makeProtobufMessageFromBytes(byte[] messageAsBytes)
|
private com.yosokumo.core.protobuf.ProtoBuf.Panel |
makeProtobufPanelFromBytes(byte[] panelAsBytes)
|
private com.yosokumo.core.protobuf.ProtoBuf.Predictor |
makeProtobufPredictorFromBytes(byte[] predictorAsBytes)
|
private com.yosokumo.core.protobuf.ProtoBuf.Predictor |
makeProtobufPredictorFromPredictor(Predictor predictor)
|
private com.yosokumo.core.protobuf.ProtoBuf.Role |
makeProtobufRoleFromBytes(byte[] roleAsBytes)
|
private com.yosokumo.core.protobuf.ProtoBuf.Role |
makeProtobufRoleFromRole(Role role)
|
private com.yosokumo.core.protobuf.ProtoBuf.Roster |
makeProtobufRosterFromBytes(byte[] rosterAsBytes)
|
private com.yosokumo.core.protobuf.ProtoBuf.Specimen |
makeProtobufSpecimenFromBytes(byte[] specimenAsBytes)
|
private com.yosokumo.core.protobuf.ProtoBuf.Specimen |
makeProtobufSpecimenFromSpecimen(Specimen specimen)
|
private com.yosokumo.core.protobuf.ProtoBuf.Panel.StatusControl |
makeProtobufStatusControlFromStatus(Study.Status status)
|
private com.yosokumo.core.protobuf.ProtoBuf.Study |
makeProtobufStudyFromBytes(byte[] studyAsBytes)
|
private com.yosokumo.core.protobuf.ProtoBuf.Study |
makeProtobufStudyFromStudy(Study study)
|
private com.yosokumo.core.protobuf.ProtoBuf.Panel.StudyNameControl |
makeProtobufStudyNameControlFromName(java.lang.String name)
|
private com.yosokumo.core.protobuf.ProtoBuf.Panel.VisibilityControl |
makeProtobufVisibilityControlFromVisibility(Study.Visibility visibility)
|
Role |
makeRoleFromBytes(byte[] roleAsBytes)
Make a Yosokumo Role object out of the bytes of an HTTP
Entity. |
private Role |
makeRoleFromProtobufRole(com.yosokumo.core.protobuf.ProtoBuf.Role protoRole)
|
Roster |
makeRosterFromBytes(byte[] rosterAsBytes)
Make a Yosokumo Roster object out of the bytes of an HTTP
Entity. |
private Roster |
makeRosterFromProtobufRoster(com.yosokumo.core.protobuf.ProtoBuf.Roster protoRoster)
|
Specimen |
makeSpecimenFromBytes(byte[] specimenAsBytes)
Make a Yosokumo Specimen object out of the bytes of an HTTP
Entity. |
private Specimen |
makeSpecimenFromProtobufSpecimen(com.yosokumo.core.protobuf.ProtoBuf.Specimen protoSpecimen)
|
Study |
makeStudyFromBytes(byte[] studyAsBytes)
Make a Yosokumo Study object out of the bytes of an HTTP
Entity. |
private Study |
makeStudyFromProtobufStudy(com.yosokumo.core.protobuf.ProtoBuf.Study protoStudy)
|
private Predictor.Level |
protoLevelToLevel(com.yosokumo.core.protobuf.ProtoBuf.Predictor.Level protoLevel)
|
private Predictor.Status |
protoStatusToStatus(com.yosokumo.core.protobuf.ProtoBuf.Predictor.Status protoStatus)
|
private Specimen.Status |
protoStatusToStatus(com.yosokumo.core.protobuf.ProtoBuf.Specimen.Status protoStatus)
|
private Study.Status |
protoStatusToStatus(com.yosokumo.core.protobuf.ProtoBuf.Study.Status protoStatus)
|
private Message.Type |
protoTypeToType(com.yosokumo.core.protobuf.ProtoBuf.Message.Type protoType)
|
private Predictor.Type |
protoTypeToType(com.yosokumo.core.protobuf.ProtoBuf.Predictor.Type protoType)
|
private Study.Type |
protoTypeToType(com.yosokumo.core.protobuf.ProtoBuf.Study.Type protoType)
|
private Study.Visibility |
protoVisibilityToVisibility(com.yosokumo.core.protobuf.ProtoBuf.Study.Visibility protoVisibility)
|
private com.yosokumo.core.protobuf.ProtoBuf.Predictor.Status |
statusToProtobufStatus(Predictor.Status status)
|
private com.yosokumo.core.protobuf.ProtoBuf.Specimen.Status |
statusToProtobufStatus(Specimen.Status status)
|
private com.yosokumo.core.protobuf.ProtoBuf.Study.Status |
statusToProtobufStatus(Study.Status status)
|
private com.yosokumo.core.protobuf.ProtoBuf.Predictor.Type |
typeToProtobufType(Predictor.Type type)
|
private com.yosokumo.core.protobuf.ProtoBuf.Study.Type |
typeToProtobufType(Study.Type type)
|
private com.yosokumo.core.protobuf.ProtoBuf.Study.Visibility |
visibilityToProtobufVisibility(Study.Visibility visibility)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
private ServiceException exception
| Constructor Detail |
|---|
YosokumoProtobuf()
| Method Detail |
|---|
public java.lang.String getContentType()
YosokumoDIF
getContentType in interface YosokumoDIFpublic ServiceException getException()
YosokumoDIFServiceException from the code-decode process.
getException in interface YosokumoDIFServiceException; null means there is no exception.public Catalog makeCatalogFromBytes(byte[] catalogAsBytes)
YosokumoDIFCatalog object out of the bytes of an HTTP
Entity.
makeCatalogFromBytes in interface YosokumoDIFcatalogAsBytes - a catalog as bytes from an HTTP Entity.
Catalog object represented by the
input bytes.private com.yosokumo.core.protobuf.ProtoBuf.Catalog makeProtobufCatalogFromBytes(byte[] catalogAsBytes)
private Catalog makeCatalogFromProtobufCatalog(com.yosokumo.core.protobuf.ProtoBuf.Catalog protoCatalog)
public Study makeStudyFromBytes(byte[] studyAsBytes)
YosokumoDIFStudy object out of the bytes of an HTTP
Entity.
makeStudyFromBytes in interface YosokumoDIFstudyAsBytes - a study as bytes from an HTTP Entity.
Study object represented by the
input bytes.private com.yosokumo.core.protobuf.ProtoBuf.Study makeProtobufStudyFromBytes(byte[] studyAsBytes)
private Study makeStudyFromProtobufStudy(com.yosokumo.core.protobuf.ProtoBuf.Study protoStudy)
public byte[] makeBytesFromStudy(Study study)
YosokumoDIFStudy
object.
makeBytesFromStudy in interface YosokumoDIFstudy - a Yosokumo Study object.
Study object.private com.yosokumo.core.protobuf.ProtoBuf.Study makeProtobufStudyFromStudy(Study study)
private byte[] makeBytesFromProtobufStudy(com.yosokumo.core.protobuf.ProtoBuf.Study protoStudy)
private Study.Type protoTypeToType(com.yosokumo.core.protobuf.ProtoBuf.Study.Type protoType)
private com.yosokumo.core.protobuf.ProtoBuf.Study.Type typeToProtobufType(Study.Type type)
private Study.Status protoStatusToStatus(com.yosokumo.core.protobuf.ProtoBuf.Study.Status protoStatus)
private com.yosokumo.core.protobuf.ProtoBuf.Study.Status statusToProtobufStatus(Study.Status status)
private Study.Visibility protoVisibilityToVisibility(com.yosokumo.core.protobuf.ProtoBuf.Study.Visibility protoVisibility)
private com.yosokumo.core.protobuf.ProtoBuf.Study.Visibility visibilityToProtobufVisibility(Study.Visibility visibility)
public byte[] makeBytesFromStudyName(java.lang.String name)
YosokumoDIFStudy
name.
makeBytesFromStudyName in interface YosokumoDIFname - a Yosokumo Study name.
Study name.private com.yosokumo.core.protobuf.ProtoBuf.Panel.StudyNameControl makeProtobufStudyNameControlFromName(java.lang.String name)
private byte[] makeBytesFromProtobufStudyNameControl(com.yosokumo.core.protobuf.ProtoBuf.Panel.StudyNameControl protoNameControl)
public byte[] makeBytesFromStudyStatus(Study.Status status)
YosokumoDIFStudy
status.
makeBytesFromStudyStatus in interface YosokumoDIFstatus - a Yosokumo Study status.
Study status.private com.yosokumo.core.protobuf.ProtoBuf.Panel.StatusControl makeProtobufStatusControlFromStatus(Study.Status status)
private byte[] makeBytesFromProtobufStatusControl(com.yosokumo.core.protobuf.ProtoBuf.Panel.StatusControl protoStatusControl)
public byte[] makeBytesFromStudyVisibility(Study.Visibility visibility)
YosokumoDIFStudy
visibility.
makeBytesFromStudyVisibility in interface YosokumoDIFvisibility - a Yosokumo Study visibility.
Study visibility.private com.yosokumo.core.protobuf.ProtoBuf.Panel.VisibilityControl makeProtobufVisibilityControlFromVisibility(Study.Visibility visibility)
private byte[] makeBytesFromProtobufVisibilityControl(com.yosokumo.core.protobuf.ProtoBuf.Panel.VisibilityControl protoVisibilityControl)
public Panel makePanelFromBytes(byte[] panelAsBytes)
YosokumoDIFPanel object out of the bytes of an HTTP
Entity.
makePanelFromBytes in interface YosokumoDIFpanelAsBytes - a panel as bytes from an HTTP Entity.
Panel object represented by the
input bytes.private com.yosokumo.core.protobuf.ProtoBuf.Panel makeProtobufPanelFromBytes(byte[] panelAsBytes)
private Panel makePanelFromProtobufPanel(com.yosokumo.core.protobuf.ProtoBuf.Panel protoPanel)
public Roster makeRosterFromBytes(byte[] rosterAsBytes)
YosokumoDIFRoster object out of the bytes of an HTTP
Entity.
makeRosterFromBytes in interface YosokumoDIFrosterAsBytes - a roster as bytes from an HTTP Entity.
Roster object represented by the
input bytes.private com.yosokumo.core.protobuf.ProtoBuf.Roster makeProtobufRosterFromBytes(byte[] rosterAsBytes)
private Roster makeRosterFromProtobufRoster(com.yosokumo.core.protobuf.ProtoBuf.Roster protoRoster)
public Role makeRoleFromBytes(byte[] roleAsBytes)
YosokumoDIFRole object out of the bytes of an HTTP
Entity.
makeRoleFromBytes in interface YosokumoDIFroleAsBytes - a role as bytes from an HTTP Entity.
Role object represented by the
input bytes.private com.yosokumo.core.protobuf.ProtoBuf.Role makeProtobufRoleFromBytes(byte[] roleAsBytes)
private Role makeRoleFromProtobufRole(com.yosokumo.core.protobuf.ProtoBuf.Role protoRole)
public byte[] makeBytesFromRole(Role role)
YosokumoDIFRole
object.
makeBytesFromRole in interface YosokumoDIFrole - a Yosokumo Role object.
Role object.private com.yosokumo.core.protobuf.ProtoBuf.Role makeProtobufRoleFromRole(Role role)
private byte[] makeBytesFromProtobufRole(com.yosokumo.core.protobuf.ProtoBuf.Role protoRole)
public Predictor makePredictorFromBytes(byte[] predictorAsBytes)
YosokumoDIFPredictor object out of the bytes of an HTTP
Entity.
makePredictorFromBytes in interface YosokumoDIFpredictorAsBytes - a predictor as bytes from an HTTP Entity.
Predictor object represented by the
input bytes.private com.yosokumo.core.protobuf.ProtoBuf.Predictor makeProtobufPredictorFromBytes(byte[] predictorAsBytes)
private Predictor makePredictorFromProtobufPredictor(com.yosokumo.core.protobuf.ProtoBuf.Predictor protoPredictor)
public byte[] makeBytesFromPredictor(Predictor predictor)
YosokumoDIFPredictor
object.
makeBytesFromPredictor in interface YosokumoDIFpredictor - a Yosokumo Predictor object.
Predictor object.private com.yosokumo.core.protobuf.ProtoBuf.Predictor makeProtobufPredictorFromPredictor(Predictor predictor)
private byte[] makeBytesFromProtobufPredictor(com.yosokumo.core.protobuf.ProtoBuf.Predictor protoPredictor)
private Predictor.Status protoStatusToStatus(com.yosokumo.core.protobuf.ProtoBuf.Predictor.Status protoStatus)
private com.yosokumo.core.protobuf.ProtoBuf.Predictor.Status statusToProtobufStatus(Predictor.Status status)
private Predictor.Type protoTypeToType(com.yosokumo.core.protobuf.ProtoBuf.Predictor.Type protoType)
private com.yosokumo.core.protobuf.ProtoBuf.Predictor.Type typeToProtobufType(Predictor.Type type)
private Predictor.Level protoLevelToLevel(com.yosokumo.core.protobuf.ProtoBuf.Predictor.Level protoLevel)
private com.yosokumo.core.protobuf.ProtoBuf.Predictor.Level levelToProtobufLevel(Predictor.Level level)
public Specimen makeSpecimenFromBytes(byte[] specimenAsBytes)
YosokumoDIFSpecimen object out of the bytes of an HTTP
Entity.
makeSpecimenFromBytes in interface YosokumoDIFspecimenAsBytes - a specimen as bytes from an HTTP Entity.
Specimen object represented by the
input bytes.private com.yosokumo.core.protobuf.ProtoBuf.Specimen makeProtobufSpecimenFromBytes(byte[] specimenAsBytes)
private Specimen makeSpecimenFromProtobufSpecimen(com.yosokumo.core.protobuf.ProtoBuf.Specimen protoSpecimen)
public byte[] makeBytesFromSpecimen(Specimen specimen)
YosokumoDIFSpecimen
object.
makeBytesFromSpecimen in interface YosokumoDIFspecimen - a Yosokumo Specimen object.
Specimen object.private com.yosokumo.core.protobuf.ProtoBuf.Specimen makeProtobufSpecimenFromSpecimen(Specimen specimen)
private byte[] makeBytesFromProtobufSpecimen(com.yosokumo.core.protobuf.ProtoBuf.Specimen protoSpecimen)
private Specimen.Status protoStatusToStatus(com.yosokumo.core.protobuf.ProtoBuf.Specimen.Status protoStatus)
private com.yosokumo.core.protobuf.ProtoBuf.Specimen.Status statusToProtobufStatus(Specimen.Status status)
public Cell makeCellFromBytes(byte[] cellAsBytes)
YosokumoDIFCell object out of the bytes of an HTTP
Entity.
makeCellFromBytes in interface YosokumoDIFcellAsBytes - a cell as bytes from an HTTP Entity.
Cell object represented by the
input bytes.private com.yosokumo.core.protobuf.ProtoBuf.Cell makeProtobufCellFromBytes(byte[] cellAsBytes)
private Cell makeCellFromProtobufCell(com.yosokumo.core.protobuf.ProtoBuf.Cell protoCell)
public byte[] makeBytesFromCell(Cell cell)
YosokumoDIFCell
object.
makeBytesFromCell in interface YosokumoDIFcell - a Yosokumo Cell object.
Cell object.private com.yosokumo.core.protobuf.ProtoBuf.Cell makeProtobufCellFromCell(Cell cell)
private byte[] makeBytesFromProtobufCell(com.yosokumo.core.protobuf.ProtoBuf.Cell protoCell)
public Block makeBlockFromBytes(byte[] blockAsBytes)
YosokumoDIFBlock object out of the bytes of an HTTP
Entity.
makeBlockFromBytes in interface YosokumoDIFblockAsBytes - a block as bytes from an HTTP Entity.
Block object represented by the input
bytes.private com.yosokumo.core.protobuf.ProtoBuf.Block makeProtobufBlockFromBytes(byte[] blockAsBytes)
private Block makeBlockFromProtobufBlock(com.yosokumo.core.protobuf.ProtoBuf.Block protoBlock)
public byte[] makeBytesFromBlock(Block block)
YosokumoDIFBlock
object.
makeBytesFromBlock in interface YosokumoDIFblock - a Yosokumo Block object.
Block object.private com.yosokumo.core.protobuf.ProtoBuf.Block makeProtobufBlockFromBlock(Block block)
private byte[] makeBytesFromProtobufBlock(com.yosokumo.core.protobuf.ProtoBuf.Block protoBlock)
public Message makeMessageFromBytes(byte[] messageAsBytes)
YosokumoDIFMessage object out of the bytes of an HTTP
Entity.
makeMessageFromBytes in interface YosokumoDIFmessageAsBytes - a message as bytes from an HTTP Entity.
Message object represented by the
input bytes.private com.yosokumo.core.protobuf.ProtoBuf.Message makeProtobufMessageFromBytes(byte[] messageAsBytes)
private Message makeMessageFromProtobufMessage(com.yosokumo.core.protobuf.ProtoBuf.Message protoMessage)
private Message.Type protoTypeToType(com.yosokumo.core.protobuf.ProtoBuf.Message.Type protoType)
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||